Org

Sleitnick · Oct 17, 2023 · 7cd4537 · 7cd4537
1 parent 355911b
commit 7cd4537
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/ts.md b/docs/ts.md
@@ -23,3 +23,13 @@ In the `tsconfig.json` file, add the `@rbxutil` directory to the types list. The
 ```json
 "typeRoots": ["node_modules/@rbxts", "node_modules/@rbxutil"]
 ```
+
+## Different Org
+
+In order to avoid naming conflicts and namespace cluttering, RbxUtil modules will be placed in their own NPM org (`@rbxutil`). This has been done out of respect for roblox-ts package developers and to allow RbxUtil to grow unbounded by the current default org packages.
+
+For example, there is already a Signal package within the default `@rbxts` org. Also, RbxUtil has many generic names, such as Log and Shake. While these are named to convey their meaning easily, it is best to not clutter the `@rbxts` org with a vast array of such names from a single repository. This naming issue is not an issue for Wally, as Wally uses the author's name as the namespace.
+
+## Contributing
+
+If you find any types that are incorrect, missing, or broken, please feel free to open up a GitHub Issue and/or pull request to address and fix these issues.