diff options
| author | EvilSeph <evilseph@gmail.com> | 2013-03-18 22:09:06 -0400 |
|---|---|---|
| committer | EvilSeph <evilseph@gmail.com> | 2013-03-18 22:16:30 -0400 |
| commit | f97e6d48d3c1b6a3a56f5415e2262b73d8e8fd9d (patch) | |
| tree | e124c6d8cbc5b0babd4d0de13fd5d198317f3174 /README.md | |
| parent | 1819a9e00ea2468278cee6f3390a6e0e0ff5dff3 (diff) | |
| download | bukkit-f97e6d48d3c1b6a3a56f5415e2262b73d8e8fd9d.tar bukkit-f97e6d48d3c1b6a3a56f5415e2262b73d8e8fd9d.tar.gz bukkit-f97e6d48d3c1b6a3a56f5415e2262b73d8e8fd9d.tar.lz bukkit-f97e6d48d3c1b6a3a56f5415e2262b73d8e8fd9d.tar.xz bukkit-f97e6d48d3c1b6a3a56f5415e2262b73d8e8fd9d.zip | |
Pull Contributing Guidelines and Requirements into CONTRIBUTING.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 0 insertions, 29 deletions
@@ -13,32 +13,3 @@ We use maven to handle our dependencies. * Install [Maven 3](http://maven.apache.org/download.html) * Check out this repo and: `mvn clean install` - -Coding and Pull Request Conventions ------------ - -* We generally follow the Sun/Oracle coding standards. -* No tabs; use 4 spaces instead. -* No trailing whitespaces. -* 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. - -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. |