Skip to content

Commit 00e4fe5

Browse files
spavlusievavladak
authored andcommitted
Update CONTRIBUTING.md
1 parent f049688 commit 00e4fe5

File tree

1 file changed

+65
-9
lines changed

1 file changed

+65
-9
lines changed

CONTRIBUTING.md

Lines changed: 65 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,74 @@
1-
Any kind of contribution is welcome. If you are not sure whether your idea is in line with
2-
the general direction of the project, feel free to submit new Issue first and let's get the discussion started there.
1+
# Contributing to this repository
2+
3+
We welcome your contributions! There are multiple ways to contribute.
4+
5+
## Opening issues
6+
7+
For bugs or enhancement requests, please file a GitHub issue unless it's
8+
security related. When filing a bug remember that the better written the bug is,
9+
the more likely it is to be fixed. If you think you've found a security
10+
vulnerability, do not raise a GitHub issue and follow the instructions in our
11+
[security policy](./SECURITY.md).
12+
13+
When submitting a new Issue for what seems is a bug, please note the versions
14+
(OpenGrok, Tomcat, Universal ctags etc.) you're running and ideally steps to reproduce.
15+
16+
Make sure to add a comment line to the changeset saying which Issue it is is fixing,
17+
e.g. `fixes #XYZ` so that the issue can be automatically closed when the associated
18+
pull request is merged.
19+
20+
## Contributing code
21+
22+
We welcome your code contributions. Before submitting code via a pull request,
23+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
24+
your commits need to include the following line using the name and e-mail
25+
address you used to sign the OCA:
26+
27+
```text
28+
Signed-off-by: Your Name <you@example.org>
29+
```
30+
31+
This can be automatically added to pull requests by committing with `--sign-off`
32+
or `-s`, e.g.
33+
34+
```text
35+
git commit --signoff
36+
```
37+
38+
Only pull requests from committers that can be verified as having signed the OCA
39+
can be accepted.
40+
41+
## Pull request process
42+
43+
Each pull request should be accompanied by a comment explaining how the change
44+
was tested, unless unit tests are provided/updated.
45+
Please make every effort to make most of your changes covered by tests. Also,
46+
for more complicated changes, please make any effort to explain the rationale
47+
behind the changes (providing answers to the 'why ?' questions is very important).
348

449
Please follow pre-existing coding style.
550

651
Asking questions via creating new [discussion](https://github.com/oracle/opengrok/discussions) is fine.
752

8-
When 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.
53+
Feel free to add a Copyright line to the source files wehre you made non-trivial changes.
954

10-
Make sure to add a comment 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.
55+
1. Ensure there is an issue created to track and discuss the fix or enhancement
56+
you intend to submit.
57+
1. Fork this repository.
58+
1. Create a branch in your fork to implement the changes. We recommend using
59+
the issue number as part of your branch name, e.g. `1234-fixes`.
60+
1. Ensure that any documentation is updated with the changes that are required
61+
by your change.
62+
1. Ensure that any samples are updated if the base image has been changed.
63+
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
64+
what your changes are meant to do and provide simple steps on how to validate.
65+
your changes. Ensure that you reference the issue you created as well.
66+
1. We will assign the pull request to 2-3 people for review before it is merged.
1167

12-
Each pull request should be accompanied by a comment explaining how the change was tested, unless unit tests are provided/updated.
13-
Please make every effort to make most of your changes covered by tests. Also, for more complicated changes, please make any effort to explain the rationale behind the changes (providing answers to the 'why ?' questions is very important).
68+
## Code of conduct
1469

15-
Feel free to add a Copyright line to the source files wehre you made non-trivial changes.
70+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
71+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
1672

17-
For a pull request to be merged, we need the contributor to sign Oracle Contributor Agreement first.
18-
See https://oca.opensource.oracle.com/ for details.
73+
[OCA]: https://oca.opensource.oracle.com
74+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

0 commit comments

Comments
 (0)