scriptoriumadmin/featurebase
1
0
Fork 0
mirror of https://github.com/featurebasedb/featurebase.git synced 2026-08-28 10:54:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

adjustments to CONTRIBUTING.md instructions

Browse source
This commit is contained in:
Travis 2017-04-17 08:01:49 -05:00
parent 5259d5ae70
commit 9c1603318c
1 changed files with 13 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -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 <yourfork> 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