From 77a963e3eb0f5054283c097bbb45cda1b3412a18 Mon Sep 17 00:00:00 2001 From: Bukkit/Spigot Date: Fri, 18 Feb 2011 17:14:18 -0500 Subject: [PATCH] Added pull request conventions that should be followed if you want your pull requests accepted. By: EvilSeph --- paper-api/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/paper-api/README.md b/paper-api/README.md index 32782fdbc5..616799aad5 100644 --- a/paper-api/README.md +++ b/paper-api/README.md @@ -11,7 +11,7 @@ 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 Conventions +Coding and Pull Request Conventions ----------- * We generally follow the Sun/Oracle coding standards. @@ -19,5 +19,8 @@ Coding Conventions * No trailing whitespaces. * No 80 column limit or midstatement newlines. * Proper javadoc for each method added/changed to describe what it does. +* 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. Follow the above conventions if you want your pull requests accepted.