CONTRIBUTING.md 1.61 KB
Newer Older
1 2
Contribution Guidelines
-----------------------
3

4
### A Note on Issues and Support ##
5

6 7
We try to be available pretty often to help when problems come up. We like to split incoming questions
into two categories: potential bugs/features, and questions. If you want a feature added, or think you've found a bug
Thomas Broadley's avatar
Thomas Broadley committed
8
in the code (or in the examples), search the [issue tracker](https://github.com/nodegit/nodegit/issues) and if you don't
9 10
find anything, file a new issue. If you just have questions, instead of using issues, [sign up](http://slack.libgit2.org/)
to libgit2's Slack instance and then contact us in the [#nodegit channel](https://libgit2.slack.com/messages/nodegit/).
11

12
## How to Help ##
13

14 15 16 17 18 19
NodeGit is iterating pretty quickly, but it can always go faster. We welcome help with the deeper darker parts,
like the templates and binding and more, but there are plenty of smaller things to do as well.
Things that are always needed:
 - Filing issues (see above).
 - Writing tests (See [here](https://github.com/nodegit/nodegit/blob/master/TESTING.md)).
 - Writing examples.
20

21 22 23
These are all good easy ways to start getting involved with the project. You can also look through the issue tracker
and see if you can help with any existing issues. Please comment with your intention and any questions before getting
started; duplicating work or doing something that would be rejected always sucks.
24

25
Additionally, [the documentation](http://www.nodegit.org) needs some love. Get in touch with one of us on Slack if
26
you'd like to lend a hand with that.
27

28
For anything else, Slack is probably the best way to get in touch as well. Happy coding, merge you soon!