Skip to content

Commit fc9a43c

Browse files
committedFeb 24, 2012
Updated README.md with more coding and pull request conventions and tips to get your pull request accepted.
1 parent 4ed32f8 commit fc9a43c

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed
 

‎README.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,25 @@ Coding and Pull Request Conventions
2020
* We generally follow the Sun/Oracle coding standards.
2121
* No tabs; use 4 spaces instead.
2222
* No trailing whitespaces.
23-
* No 80 column limit or midstatement newlines.
24-
* No CRLF lineendigs, LF only, put your gits 'core.autocrlf' on 'true'
25-
* Proper javadoc for each method added/changed to describe what it does.
23+
* No CRLF line endings, LF only, put your gits 'core.autocrlf' on 'true'.
24+
* No 80 column limit or 'weird' midstatement newlines.
2625
* 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!).
2726
* No merges should be included in pull requests unless the pull request's purpose is a merge.
2827
* Pull requests should be tested (does it compile? AND does it work?) before submission.
28+
* Any major additions should have documentation ready and provided if applicable (this is usually the case).
29+
* 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).
30+
* Try to follow test driven development where applicable.
2931

30-
Follow the above conventions if you want your pull requests accepted.
32+
Tips to get your pull request accepted
33+
-----------
34+
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.
35+
36+
* Make sure you follow all of our conventions to the letter.
37+
* Make sure your code compiles under Java 5.
38+
* Provide proper JavaDocs where appropriate.
39+
* Provide proper accompanying documentation where appropriate.
40+
* Test your code.
41+
* Make sure to follow coding best practises.
42+
* Provide a test plugin binary and source for us to test your code with.
43+
* Your pull request should link to accompanying pull requests.
44+
* The description of your pull request should provide detailed information on the pull along with justification of the changes where applicable.

0 commit comments

Comments
 (0)
Please sign in to comment.