Altitude/AlttdGriefPrevention
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Create CONTRIBUTING.md

Browse Source 
Closes #460
This commit is contained in:
RoboMWM 2019-08-18 10:22:40 -07:00 committed by GitHub
parent 08f8d81ca4
commit cf5bbe4833
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,26 @@
# Pull Requests
Pull requests are encouraged! To increase the likelihood of your PR being pulled, here are some guidelines to follow:
- Each PR must address only a single feature/improvement
- This makes for an easier-to-read diff and focused feedback.
- PRs that aim to solve multiple issues causes scattered feedback and a hard-to-follow diff
- Maintain consistency where possible
- Newline braces
- The majority of 16.x uses tabs
- Version 20+ will uses spaces
- This guideline will be updated when version 20 becomes generally available
- Do not change version in pom.xml.
- Feel free to contribute to the dev/v20 branch (may be advised to discuss in #63)
## Tips
- Avoid nesting - check for the inverted value and return early (not easy to do though in legacy versions where many methods are "uber methods" containing a lot of control flow).
- Use `Entity#getType` instead of `instanceof` where appropriate (`getType` is faster).
# Issues
- Try to search for your bug/suggestion first. Someone may have already created one.
- If not, please fill out the template for the respective issue you are creating.