From 9c1603318c4e08f29d313243eff3ae49e4e38a91 Mon Sep 17 00:00:00 2001 From: Travis Date: Mon, 17 Apr 2017 08:01:49 -0500 Subject: [PATCH] adjustments to CONTRIBUTING.md instructions --- CONTRIBUTING.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8e4d57a1..62113a697 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## Reporting a bug -If you have discovered a bug, [open a new issue][1] +If you have discovered a bug and don't see it in the [github issue tracker][5], [open a new issue][1] ## Submitting a feature request @@ -11,6 +11,10 @@ which starts by [opening a new issue][1] that describes the new feature proposal ## Submitting code changes +Before you start working on new features, you should [open a new issue][1] to let others know what +you're doing before you start working, otherwise you run the risk of duplicating effort. This also +gives others an opportunity to provide input for your feature. + - Fork the [Pilosa repository][2] and then clone your fork: ```shell @@ -18,7 +22,7 @@ which starts by [opening a new issue][1] that describes the new feature proposal ``` - Create a local feature branch: - + ```shell git checkout -b something-amazing ``` @@ -26,20 +30,21 @@ which starts by [opening a new issue][1] that describes the new feature proposal - Commit your changes locally using `git add` and `git commit`. - Make sure that you've written tests for your new feature, and then run the tests: - + ```shell make test ``` -- Verify that your pull request is applied to the latest version of code on `origin/master`: +- Verify that your pull request is applied to the latest version of code on github: ```shell - git fetch origin - git rebase -i --exec "make test" origin/master + git remote add upstream git@github.com:pilosa/pilosa.git + git fetch upstream + git rebase -i upstream/master ``` - Push to your fork: - + ```shell git push -u something-amazing ``` @@ -51,3 +56,4 @@ which starts by [opening a new issue][1] that describes the new feature proposal [2]: https://github.com/pilosa/pilosa [3]: https://github.com/pilosa/pilosa/compare/ [4]: https://github.com/pilosa/general/blob/master/proposal.md +[5]: https://github.com/pilosa/pilosa/issues