summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorRoger Meier <roger@apache.org>2015-04-07 23:05:31 +0200
committerRoger Meier <roger@apache.org>2015-04-07 23:05:31 +0200
commite035c1a9c5e1304471cdd6284781628bb237aa44 (patch)
tree32fa06b3cf961739d2f0fdc8e95db250ec2aa66d /CONTRIBUTING.md
parentb818185cf8b463cd96189ad75dfbe8ac99c54ba1 (diff)
downloadthrift-e035c1a9c5e1304471cdd6284781628bb237aa44.tar.gz
CONTRIBUTING.md: add info on branch names and commit message for GitHub PR's
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a569fd729..a6d4dfab1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,5 @@
## How to contribute
-
+ 1. Help to review and verify existing patches
1. Make sure your issue is not all ready in the [Jira issue tracker](http://issues.apache.org/jira/browse/THRIFT)
1. If not, create a ticket describing the change you're proposing in the [Jira issue tracker](http://issues.apache.org/jira/browse/THRIFT)
1. Contribute your patch using one of the two methods below
@@ -27,14 +27,14 @@
### Contributing via GitHub pull requests
1. Create a fork for http://github.com/apache/thrift
-1. Create a branch for your changes
+1. Create a branch for your changes(best practice is issue as branch name, e.g. THRIFT-9999)
1. Modify the source to include the improvement/bugfix
* Remember to provide *tests* for all submited changes
* When bugfixing: add test that will isolate bug *before* applying change that fixes it
* Verify that you follow [Thrift Coding Standards](/coding_standards) (you can run 'make style', which ensures proper format for some languages)
-1. Commit and push changes to your branch
+1. Commit and push changes to your branch (please use issue name and description as commit title, e.g. THRIFT-9999 make it perfect)
1. Issue a pull request with the jira ticket number you are working on in it's name
1. Wait for other contributors or committers to review your new addition
1. Wait for a committer to commit your patch