fix: address PR comments

DiscordLuau · Jan 14, 2025 · 48e9fee · 48e9fee
1 parent 808a447
commit 48e9fee
Show file tree

Hide file tree

Showing 34 changed files with 41 additions and 96 deletions.
diff --git a/CONTRIBUTING b/CONTRIBUTING
@@ -5,6 +5,14 @@ When contributing to this repository, please first discuss the change you wish t
 Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
 
 ## Development environment setup
+1. Git clone the projects repository *(`git clone https://github.com/DiscordLuau/discord-luau.git`)*
+2. Install all dependencies *(`pesde install`)*
+	i. in the event pesde errors, try running pesde a second time.
+3. Use `Lune` to start the `development.luau` script
+	i. `lune run development`
+
+## Code Style Guide
+We've generally adopted a mix of Lunes lua styleguide, as well as Pesdes lua styleguides, these styleguides aren't written down anywhere in detail, but generally lean towards how one of the two projects write their code. *(Lean towards Lune, and where thats not possible - pesde.)*
 
 
 ## Issues and feature requests

diff --git a/packages/api-types/CONTRIBUTING b/packages/api-types/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/api-types/README.md b/packages/api-types/README.md
@@ -29,13 +29,8 @@ local channel = getChannel(channelId) :: DiscordTypes.GetChannelResponse
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/bit/CONTRIBUTING b/packages/bit/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/bit/README.md b/packages/bit/README.md
@@ -29,13 +29,8 @@ local b = Bit.band(3, 42)
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/buffer/CONTRIBUTING b/packages/buffer/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/buffer/README.md b/packages/buffer/README.md
@@ -35,13 +35,8 @@ local completeMessage = zlibBuffer:flush()
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/builders/CONTRIBUTING b/packages/builders/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/builders/README.md b/packages/builders/README.md
@@ -35,13 +35,8 @@ local channelObject = Builders.channel.new()
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/classes/CONTRIBUTING b/packages/classes/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/classes/README.md b/packages/classes/README.md
@@ -34,13 +34,8 @@ discordMessageClass:replyAsync({
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/discord_luau/CONTRIBUTING b/packages/discord_luau/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/discord_luau/README.md b/packages/discord_luau/README.md
@@ -41,13 +41,8 @@ end)
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/emitter/CONTRIBUTING b/packages/emitter/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/emitter/README.md b/packages/emitter/README.md
@@ -37,13 +37,8 @@ event:invoke()
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/formdata/CONTRIBUTING b/packages/formdata/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/formdata/README.md b/packages/formdata/README.md
@@ -38,13 +38,8 @@ local header =  formdataObject:getHeader()
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/logger/CONTRIBUTING b/packages/logger/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/logger/README.md b/packages/logger/README.md
@@ -32,13 +32,8 @@ log:Warn(`This is a warning message!`)
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/rest/CONTRIBUTING b/packages/rest/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/rest/README.md b/packages/rest/README.md
@@ -34,13 +34,8 @@ local channelObject = REST.channel:getChannelAsync(request, channelId)
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/secret/CONTRIBUTING b/packages/secret/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/secret/README.md b/packages/secret/README.md
@@ -33,13 +33,8 @@ print(tostring(secret))
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/snowflake/CONTRIBUTING b/packages/snowflake/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/snowflake/README.md b/packages/snowflake/README.md
@@ -33,13 +33,8 @@ local processId = object:getProcessId()
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/state/CONTRIBUTING b/packages/state/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/state/README.md b/packages/state/README.md
@@ -42,13 +42,8 @@ local object = State.new(
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/std-polyfills/CONTRIBUTING b/packages/std-polyfills/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/std-polyfills/README.md b/packages/std-polyfills/README.md
@@ -31,13 +31,8 @@ local DateTime = Std.datetime.now()
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/stream/CONTRIBUTING b/packages/stream/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/stream/README.md b/packages/stream/README.md
@@ -31,13 +31,8 @@ print(object:advance(5))
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/utilities/CONTRIBUTING b/packages/utilities/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING
diff --git a/packages/utilities/README.md b/packages/utilities/README.md
@@ -29,13 +29,8 @@ Util.validateKebabCase("hello-world")
 ```
 
 ### Contributing
-We welcome contributions! If you find an issue or have ideas for improvement:
 
-1. Fork the repository.
-2. Create a new branch for your feature or fix.
-3. Submit a pull request.
-
-Please ensure your contributions align with our contribution guidelines.
+See the [Contributing Guide](CONTRIBUTING) for more information on how to contribute to this project.
 
 ### License
 This project is licensed under the MIT License. Feel free to use it in your projects.
diff --git a/packages/voice/CONTRIBUTING b/packages/voice/CONTRIBUTING
@@ -0,0 +1 @@
+../../CONTRIBUTING