feat: better gen-list + pr template (#100)

This commit is contained in:
Jacob Nguyen
2023-09-01 11:51:35 -05:00
committed by GitHub
parent c0a36cc204
commit 63253dce8f
18 changed files with 280 additions and 137 deletions

35
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,35 @@
## Plugin Submission Checklist
Before submitting your plugin, please ensure that you have followed the specifications below:
- [ ] Your plugin code includes a JSDoc block with `@plugin` at the beginning and `@end` at the end.
- [ ] The order of plugin metadata within the JSDoc block follows the structure provided:
1. `@plugin`
2. `description`
3. `@author` (you can have multiple authors in this format: `@author @jacoobes [<@182326315813306368>]`)
4. `@version` (with the version number)
5. `@example` (a nice example of how to use your plugin)
6. `@end`
## Plugin Submission Details
**Description:**
_[Please provide a brief description of your plugin here.]_
**Authors:**
_[List the authors of the plugin along with their Discord IDs in the format `@username [<@discord_id>]`. You can add multiple authors in this manner.]_
**Version:**
_[Specify the version number of your plugin.]_
**Example:**
_[Provide an example of how your plugin can be used here.]_
## Additional Notes
_[Include any additional information or notes you'd like to provide regarding your plugin submission.]_