Skip to content

Commit e05a2ef

Browse files
committed
Add CONTRIBUTING file
1 parent 2a6be23 commit e05a2ef

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
We welcome your contributions! There are multiple ways to contribute.
4+
5+
## 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
9+
is, 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 on our
11+
[Security Policy](./.github/SECURITY.md).
12+
13+
## Contributing Code
14+
15+
To get started, you will need to sign the [Oracle Contributor
16+
Agreement](https://oca.opensource.oracle.com) (OCA).
17+
18+
For pull requests to be accepted, the bottom of your commit message must have
19+
the following line using the name and e-mail address you used for the OCA.
20+
21+
```text
22+
Signed-off-by: Your Name <you@example.org>
23+
```
24+
25+
This can be automatically added to pull requests by committing with:
26+
27+
```text
28+
git commit --signoff
29+
```
30+
31+
Only pull requests from committers that can be verified as having
32+
signed the OCA can be accepted.
33+
34+
### Pull request process
35+
36+
1. Fork this repository
37+
1. Create a branch in your fork to implement the changes. We recommend using
38+
the issue number as part of your branch name, e.g. `1234-fixes`
39+
1. Ensure that any documentation is updated with the changes that are required
40+
by your fix.
41+
1. Ensure that any samples are updated if the base image has been changed.
42+
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
43+
what your changes are meant to do and provide simple steps on how to validate
44+
your changes. Ensure that you reference the issue you created as well.
45+
1. We will review your PR before it is merged.
46+
47+
## Code of Conduct
48+
49+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
50+
like more specific guidelines see the [Contributor Covenant Code of
51+
Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)

0 commit comments

Comments
 (0)