From cf5bbe4833ac451841b48c8c6828cc59d98ce246 Mon Sep 17 00:00:00 2001 From: RoboMWM Date: Sun, 18 Aug 2019 10:22:40 -0700 Subject: [PATCH] Create CONTRIBUTING.md Closes #460 --- .github/CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..f1a6847 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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.