xref: /OpenGrok/CONTRIBUTING.md (revision 5278970e3e308f0948d147876e19006c7b94b500)
1Any kind of contribution is welcome. If you are not sure whether your idea is in line with
2the general direction of the project, feel free to submit new Issue first and let's get the discussion started there.
3
4Please follow pre-existing coding style.
5
6Asking questions via creating new Issue is fine also.
7
8When submitting a new Issue for what seems is a bug, please note the versions (OpenGrok, Tomcat, Universal ctags etc.) you're running and ideally steps to reproduce.
9
10Make sure to add a comment line line to the changeset saying which Issue it is is fixing, e.g. `fixes #XYZ` so that the issue can be automatically closed when the associated pull request is merged.
11
12Each pull request should be accompanied by a comment explaining how the change was tested, unless unit tests are provided/updated.
13Please make every effort to make most of your changes covered by tests.
14
15Feel free to add a Copyright line to the source files wehre you made non-trivial changes.
16
17For a pull request to be merged, we need the contributor to sign Oracle Contributor Agreement first.
18See http://www.oracle.com/technetwork/community/oca-486395.html for details.
19