Skip to content

Commit c787ad6

Browse files
committed
Moved contribution guidelines to dedicated file.
1 parent d439c2d commit c787ad6

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
3+
Feel free to contribute bug-fixes and new features. If you do so, please apply the
4+
[Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow. This sounds more
5+
complicated than it is. Check out
6+
the [Getting Started](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
7+
to initialize your forked project for Gitflow usage. Then use:
8+
9+
* `git flow feature start feature_branch` when contributing a new feature, this is always based on the `develop` branch
10+
* `git flow hotfix start hotfix_branch` when contributing a patch, this is always based on the `master` branch.
11+
12+
Replace `feature_branch` or `hotfix_branch` in the above example with a descriptive name. Do not finish the feature or
13+
hotfix, but do a pull request on the new branch.

README.md

-14
Original file line numberDiff line numberDiff line change
@@ -83,20 +83,6 @@ actually testing features on dbs/documents.
8383

8484
If bash is available on your environment, you can also use the `test.sh` script which basically does the same thing described above.
8585

86-
## Contributing
87-
88-
Feel free to contribute bug-fixes and new features. If you do so, please apply the
89-
[Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow. This sounds more
90-
complicated than it is. Check out
91-
the [Getting Started](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
92-
to initialize your forked project for Gitflow usage. Then use:
93-
94-
* `git flow feature start feature_branch` when contributing a new feature, this is always based on the `develop` branch
95-
* `git flow hotfix start hotfix_branch` when contributing a patch, this is always based on the `master` branch.
96-
97-
Replace `feature_branch` or `hotfix_branch` in the above example with a descriptive name. Do not finish the feature or
98-
hotfix, but do a pull request on the new branch.
99-
10086
## License
10187

10288
Licensed under either of these:

0 commit comments

Comments
 (0)