|
1 |
| -## Creating Releases |
2 |
| -To release the project create a new github release. This will trigger the release workflow (implemented using GitHub Actions). |
3 |
| -Set both tag and name ing a format: `v[major].[minor].[patch]`, sample: `v1.2.23`. |
4 |
| -Follow classic semver guidelines. Note that the version in the pom files |
5 |
| -is based on tag name not on release name in the release workflow. |
| 1 | +# Contributing To Java Operator SDK |
6 | 2 |
|
| 3 | +Firstly, big thanks for considering contributing to the project. We really hope to make this into a |
| 4 | +community project and to do that we need your help! |
| 5 | + |
| 6 | +## Code of Conduct |
| 7 | + |
| 8 | +We are serious about making this a welcoming, happy project. We will not tolerate discrimination, |
| 9 | +aggressive or insulting behaviour. |
| 10 | + |
| 11 | +To this end, the project and everyone participating in it is bound by the [Code of |
| 12 | +Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report |
| 13 | +unacceptable behaviour to any of the project admins or [email protected]. |
| 14 | + |
| 15 | +## Bugs |
| 16 | + |
| 17 | +If you find a bug, please [open an issue](https://github.com/ContainerSolutions/java-operator-sdk/issues)! Do try |
| 18 | +to include all the details needed to recreate your problem. This is likely to include: |
| 19 | + |
| 20 | + - The version of the Operator SDK being used |
| 21 | + - The exact platform and version of the platform that you're running on |
| 22 | + - The steps taken to cause the bug |
| 23 | + |
| 24 | +## Building Features and Documentation |
| 25 | + |
| 26 | +If you're looking for something to work on, take look at the issue tracker, in particular any items |
| 27 | +labelled [good first issue](https://github.com/ContainerSolutions/java-operator-sdk/labels/good%20first%20issue). |
| 28 | +Please leave a comment on the issue to mention that you have started work, in order to avoid |
| 29 | +multiple people working on the same issue. |
| 30 | + |
| 31 | +If you have an idea for a feature - whether or not you have time to work on it - please also open an |
| 32 | +issue describing your feature and label it "enhancement". We can then discuss it as a community and |
| 33 | +see what can be done. Please be aware that some features may not align with the project goals and |
| 34 | +might therefore be closed. In particular, please don't start work on a new feature without |
| 35 | +discussing it first to avoid wasting effort. We do commit to listening to all proposals and will do |
| 36 | +our best to work something out! |
| 37 | + |
| 38 | +Once you've got the go ahead to work on a feature, you can start work. Feel free to communicate with |
| 39 | +team via updates on the issue tracker or the Discord channel and ask for feedback, pointers etc. |
| 40 | +Once you're happy with your code, go ahead and open a Pull Request. |
| 41 | + |
| 42 | +## Pull Request Process |
| 43 | + |
| 44 | +On opening a PR, a GitHub action will execute the test suite against the new code. All code is |
| 45 | +required to pass the tests, and new code must be accompanied by new tests. |
| 46 | + |
| 47 | +All PRs have to be reviewed and signed off by another developer before being merged to the master |
| 48 | +branch. This review will likely ask for some changes to the code - please don't be alarmed or upset |
| 49 | +at this; it is expected that all PRs will need tweaks and a normal part of the process. |
| 50 | + |
| 51 | +Be aware that all Operator SDK code is released under the [Apache 2.0 licence](LICENSE). |
| 52 | + |
| 53 | +### Thanks |
| 54 | + |
| 55 | +These guidelines were best on several sources, including |
| 56 | +[Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md), [PurpleBooth's |
| 57 | +advice](https://gist.github.com/PurpleBooth/b24679402957c63ec426) and the [Contributor |
| 58 | +Covenant](https://www.contributor-covenant.org/). |
0 commit comments