diff options
| author | EvilSeph <evilseph@gmail.com> | 2012-02-24 00:08:31 -0500 |
|---|---|---|
| committer | EvilSeph <evilseph@gmail.com> | 2012-02-24 00:09:28 -0500 |
| commit | 098f5ea5b69f79760693cf0c38e95e037875eadc (patch) | |
| tree | 59b9cfedbe67e535332df1c70d20cab1e68e4ee0 /README.md | |
| parent | e0fc150d8f44f8c5198cb5ec6761bbea60199ff4 (diff) | |
| download | bukkit-098f5ea5b69f79760693cf0c38e95e037875eadc.tar bukkit-098f5ea5b69f79760693cf0c38e95e037875eadc.tar.gz bukkit-098f5ea5b69f79760693cf0c38e95e037875eadc.tar.lz bukkit-098f5ea5b69f79760693cf0c38e95e037875eadc.tar.xz bukkit-098f5ea5b69f79760693cf0c38e95e037875eadc.zip | |
Updated README.md with more coding and pull request conventions and tips to get your pull request accepted.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 18 insertions, 4 deletions
@@ -20,11 +20,25 @@ Coding and Pull Request Conventions * We generally follow the Sun/Oracle coding standards. * No tabs; use 4 spaces instead. * No trailing whitespaces. -* No 80 column limit or midstatement newlines. -* No CRLF lineendigs, LF only, put your gits 'core.autocrlf' on 'true' -* Proper javadoc for each method added/changed to describe what it does. +* No CRLF line endings, LF only, put your gits 'core.autocrlf' on 'true'. +* No 80 column limit or 'weird' midstatement newlines. * The number of commits in a pull request should be kept to a minimum (squish them into one most of the time - use common sense!). * No merges should be included in pull requests unless the pull request's purpose is a merge. * Pull requests should be tested (does it compile? AND does it work?) before submission. +* Any major additions should have documentation ready and provided if applicable (this is usually the case). +* Most pull requests should be accompanied by a corresponding Leaky ticket so we can associate commits with Leaky issues (this is primarily for changelog generation on dl.bukkit.org). +* Try to follow test driven development where applicable. -Follow the above conventions if you want your pull requests accepted. +Tips to get your pull request accepted +----------- +Making sure you follow the above conventions is important, but just the beginning. Follow these tips to better the chances of your pull request being accepted and pulled. + +* Make sure you follow all of our conventions to the letter. +* Make sure your code compiles under Java 5. +* Provide proper JavaDocs where appropriate. +* Provide proper accompanying documentation where appropriate. +* Test your code. +* Make sure to follow coding best practises. +* Provide a test plugin binary and source for us to test your code with. +* Your pull request should link to accompanying pull requests. +* The description of your pull request should provide detailed information on the pull along with justification of the changes where applicable. |