zhdev/griefus
1
0
Fork 0
Code Issues Pull requests Activity

Updated PR guidelines

Browse source
This commit is contained in:
Intelli 2021-07-15 16:04:58 -06:00
parent c09e83e844
commit ebb5a99cc7
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -10,10 +10,12 @@ Please note we have a code of conduct, please follow it in all your interactions
- For consistency, please only use spaces for indentation. - For consistency, please only use spaces for indentation.
- Use descriptiveCamelCase for variable/method names. Names containing underscore or abbreviations should be changed. - Use descriptiveCamelCase for variable/method names. Names containing underscore or abbreviations should be changed.
- Restrict changes in a commit to a single event or section of code (e.g. refactor BlockBreakEvent and BlockPlaceEvent in separate commits) - Restrict changes in a commit to a single event or section of code (e.g. refactor BlockBreakEvent and BlockPlaceEvent in separate commits)
- Attempt to keep the amount of code refactored in a single commit small and readable. - Attempt to keep the amount of code modified in a single commit small and readable.
- When adding new functionality, please also be sure to update the documentation as well. - When adding new functionality, please also be sure to update the documentation as well.
- Use common sense. If you have a suggestion for a contribution guideline, post it on Discord. - Use common sense. If you have a suggestion for a contribution guideline, post it on Discord.
Please note that although numerous improvements have been made to the codebase over the past few years, there’s still significant work to be done. Parts of this plugin are over a decade old, and new functionality is continuously being added. Refactoring is welcomed, but please be sure to keep commits a reasonable size.
## Code of Conduct ## Code of Conduct
### Our Pledge ### Our Pledge