Skip to content
This repository was archived by the owner on Mar 25, 2021. It is now read-only.

Commit 66e0bfe

Browse files
author
eyarz
authored
Create CONTRIBUTING.md
1 parent 12a881c commit 66e0bfe

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# How to contribute
2+
3+
We like to encourage you to contribute to the repository.
4+
This should be as easy as possible for you but there are a few things to consider when contributing.
5+
The following guidelines for contribution should be followed if you want to submit a pull request.
6+
7+
## How to prepare
8+
9+
* Submit an [issue ticket](https://github.com/datreeio/node-datreeio/issues) for your issue if there is no one yet.
10+
* Fork the repository on GitHub
11+
12+
## Make Changes
13+
14+
* In your forked repository, create a topic branch for your upcoming patch.
15+
* Create a branch based on master.
16+
* Make sure you stick to the coding style that is used already.
17+
* Make commits of logical units and describe them properly.
18+
* Check for unnecessary whitespace with `git diff --check` before committing
19+
* If possible, submit tests to your patch / new feature so it can be tested easily.
20+
* Assure nothing is broken by running all the tests.
21+
22+
## Submit Changes
23+
24+
* Push your changes to a topic branch in your fork of the repository.
25+
* Open a pull request to the original repository and choose the right original branch you want to patch.
26+
* If not done in commit messages (which you really should do) please reference and update your issue with the code changes.
27+
* Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve.
28+
29+
# Additional Resources
30+
31+
* [General GitHub documentation](http://help.github.com/)
32+
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)

0 commit comments

Comments
 (0)