diff options
author | Danny van Bruggen <lol@meuk.info> | 2016-10-06 14:42:31 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-10-06 14:42:31 +0200 |
commit | b612d63cb2b0740d61e74acd1ec41ca172f0e0fa (patch) | |
tree | 1567d425bec8abfac1656df414e17866e78b88f3 /CONTRIBUTING.md | |
parent | 5894380ec06788f6b95639aefe782b03788bd7aa (diff) | |
download | javaparser-b612d63cb2b0740d61e74acd1ec41ca172f0e0fa.tar.gz |
Add a draft contributing.md (#489)
* Add contributing.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..85de788ce --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +Here is some information that's good to know when contributing to JavaParser: + +- if you're new and like to contribute something, check out the [easy issues](https://github.com/javaparser/javaparser/labels/Easy). +- we work on JavaParser because we like to, not because it earns us money. Please remember that we try to run a professional project in our spare time, on a budget of zero. +- if you know how to fix a problem, please fix it and open a pull request instead of opening an issue. +- if you start working on an issue, please say so with a comment in the issue. +- a pull request should include tests. You can either use BDD ([more information here](https://github.com/javaparser/javaparser/wiki/Testing)) or JUnit. +- every pull request will automatically be checked by a few tools. Make sure AppVeyor and Travis are green. +- there is some interesting information on the [wiki](https://github.com/javaparser/javaparser/wiki). +- be sure to check [the coding guidelines](https://github.com/javaparser/javaparser/wiki/Coding-Guidelines) which are easily used by installing the formatting rules as described there. +- pull requests often stay open for at least a few days to give people a chance to review it. +- a pull request is merged when all comments on it have been resolved. +- if you create a pull request for an issue, mention the issue in the format #123 to make github link it automatically. + +Thanks for helping! |