From a72f289b8438dd719981ebb71ddc8955b98d147b Mon Sep 17 00:00:00 2001
From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
Date: Thu, 27 Mar 2025 09:48:52 -0500
Subject: [PATCH 1/4] docs: update CONTRIBUTING_JS.md

add some more details to align with unknown expectations that I've seen from contributors lately.

i.e. https://github.com/ipfs/ipfs-webui/issues/2349
---
 CONTRIBUTING_JS.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING_JS.md b/CONTRIBUTING_JS.md
index 6f9835e..f46f4d8 100644
--- a/CONTRIBUTING_JS.md
+++ b/CONTRIBUTING_JS.md
@@ -91,12 +91,36 @@ We do not go out of our way to break compatibility with platforms, but we can on
 
 Some modules do not support certain platforms, these should be easy to spot - e.g. `@libp2p/tcp` supports only Node.js and Electron because TCP does not work in web browsers.
 
+#### Files
+
+##### TypeScript
+
+We encourage the use of TypeScript for type safety and improved developer experience. When adding new files, prefer .ts for standard TypeScript files and .tsx for React components. Ensure that TypeScript configurations align with the project's existing settings. 
+
+`aegir` can help you set up a new project with an appropriate tsconfig.json.
+
+##### Case-sensitivity
+
+Adopt kebab-case (lowercase letters with hyphens separating words) for filenames to maintain consistency across all our projects and limit issues with case-insensitive filesystems. For instance, name a file `example-file.ts` instead of `exampleFile.ts` or `example_file.ts`.
+
 #### Linting & Code Style
 
-IPFS JavaScript projects default to [eslint-config-ipfs](https://github.com/ipfs/eslint-config-ipfs) which is based on [standard](https://github.com/feross/standard) code style. It is a clean codestyle, and its adoption is increasing significantly, making the code that we write familiar to the majority of the developers.
+IPFS JavaScript projects default to [eslint-config-ipfs](https://github.com/ipfs/eslint-config-ipfs) which is based on [standard](https://github.com/feross/standard) code style. It is a clean codestyle, and its adoption is increasing significantly, making the code that we write familiar to the majority of the developers. 
 
 Using [aegir-lint](#aegir) will help you do this easily; it automatically lints your code.
 
+##### Importing modules and files
+
+When writing import statements, include file extensions to comply with ECMAScript Module (ESM) standards. For example:
+
+```ts
+import { exampleFunction } from './example-file.js';
+```
+
+This practice ensures compatibility across different environments and aligns with modern JavaScript standards.
+
+
+
 #### Dependency Versions
 
 Our rule is: Use ~ for everything below 1.0.0 and ^ for everything above 1.0.0. If you find a package.json that is not following this rule, please submit a PR.
@@ -135,6 +159,18 @@ A `gh-pages` branch will be created, and this should be published to via the Git
 
 This makes API docs available, and the types are linked through to from other modules published by aegir.
 
+aegir can also update the `About` section of a README.md based on the `@packageDocumentation` of your entry file.
+
+#### Front-end and UI
+
+##### React
+
+For projects utilizing React, adhere to the following standards:
+
+1. Component Naming: Use kebab-case for component names (e.g., `my-component`). This is different than idiomatic React, which uses PascalCase.​
+2. File Extensions: Use .tsx for files containing React components to leverage TypeScript's JSX support.​
+3. State Management: Prefer using React's built-in state management features. If additional state management libraries are needed, please ensure they are well-justified, align with the project's architecture, and are well-typed. 
+
 ### Commits
 
 We have guidelines for how our git commit messages should be formatted. This leads to more readable messages that are easy to follow when looking through the project history.  But also, we use the git commit messages to generate the change log.

From be8b7c41c4c982563bab1c1cc070dbfcd964c36b Mon Sep 17 00:00:00 2001
From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
Date: Thu, 27 Mar 2025 09:54:03 -0500
Subject: [PATCH 2/4] chore: Update CONTRIBUTING_JS.md

Co-authored-by: Alex Potsides <alex@achingbrain.net>
---
 CONTRIBUTING_JS.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING_JS.md b/CONTRIBUTING_JS.md
index f46f4d8..358ab21 100644
--- a/CONTRIBUTING_JS.md
+++ b/CONTRIBUTING_JS.md
@@ -159,7 +159,7 @@ A `gh-pages` branch will be created, and this should be published to via the Git
 
 This makes API docs available, and the types are linked through to from other modules published by aegir.
 
-aegir can also update the `About` section of a README.md based on the `@packageDocumentation` of your entry file.
+aegir can also update the `About` section of a README.md based on the `@packageDocumentation` of your entry file via the `aegir docs` command.
 
 #### Front-end and UI
 

From 4774db7f514c462702df4eadbc828b6c0396cb0e Mon Sep 17 00:00:00 2001
From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
Date: Thu, 27 Mar 2025 09:54:24 -0500
Subject: [PATCH 3/4] Update CONTRIBUTING_JS.md

Co-authored-by: Alex Potsides <alex@achingbrain.net>
---
 CONTRIBUTING_JS.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING_JS.md b/CONTRIBUTING_JS.md
index 358ab21..dabc5fe 100644
--- a/CONTRIBUTING_JS.md
+++ b/CONTRIBUTING_JS.md
@@ -105,7 +105,7 @@ Adopt kebab-case (lowercase letters with hyphens separating words) for filenames
 
 #### Linting & Code Style
 
-IPFS JavaScript projects default to [eslint-config-ipfs](https://github.com/ipfs/eslint-config-ipfs) which is based on [standard](https://github.com/feross/standard) code style. It is a clean codestyle, and its adoption is increasing significantly, making the code that we write familiar to the majority of the developers. 
+IPFS JavaScript projects default to [eslint-config-ipfs](https://github.com/ipfs/eslint-config-ipfs) which is based on [standard](https://github.com/feross/standard) code style. It is a clean codestyle, and its adoption is increasing significantly, making the code that we write familiar to the majority of the developers.
 
 Using [aegir-lint](#aegir) will help you do this easily; it automatically lints your code.
 

From a207ad5c596ffddde58a251f1204af5583d72ddf Mon Sep 17 00:00:00 2001
From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
Date: Thu, 27 Mar 2025 09:54:34 -0500
Subject: [PATCH 4/4] Update CONTRIBUTING_JS.md

Co-authored-by: Alex Potsides <alex@achingbrain.net>
---
 CONTRIBUTING_JS.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/CONTRIBUTING_JS.md b/CONTRIBUTING_JS.md
index dabc5fe..5b865d1 100644
--- a/CONTRIBUTING_JS.md
+++ b/CONTRIBUTING_JS.md
@@ -119,8 +119,6 @@ import { exampleFunction } from './example-file.js';
 
 This practice ensures compatibility across different environments and aligns with modern JavaScript standards.
 
-
-
 #### Dependency Versions
 
 Our rule is: Use ~ for everything below 1.0.0 and ^ for everything above 1.0.0. If you find a package.json that is not following this rule, please submit a PR.