Skip to content

Commit 403d619

Browse files
Guidelines for Contribution and PR review. (#2)
1 parent 8375dd5 commit 403d619

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
# How to contribute
22

3-
Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into operator-sdk.
3+
Java Operator is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into the Java Operator.
4+
5+
## Email and Chat
6+
7+
- Email: [operator-framework][operator_framework]
48

59
## Getting started
610

711
- Fork the repository on GitHub
12+
https://github.com/operator-framework/java-operator.git
13+
14+
- If you want to build/run the project, use command
15+
`TBD`
816

917
## Reporting bugs and creating issues
1018

11-
Reporting bugs is one of the best ways to contribute.
19+
Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on reporting issues before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug.
1220

1321
## Contribution flow
1422

@@ -17,6 +25,8 @@ This is a rough outline of what a contributor's workflow looks like:
1725
- Create a topic branch from where to base the contribution. This is usually master.
1826
- Make commits of logical units.
1927
- Make sure commit messages are in the proper format (see below).
28+
- Check your work after running all Unit and Regression Tests. You should run all the unit tests by hitting the following command
29+
`TBD`
2030
- Push changes in a topic branch to a personal fork of the repository.
2131
- Submit a pull request to operator-framework/operator-sdk.
2232
- The PR must receive a LGTM from two maintainers found in the MAINTAINERS file.
@@ -25,7 +35,7 @@ Thanks for contributing!
2535

2636
### Code style
2737

28-
The coding style suggested by the Golang community is used in operator-sdk. See the [style doc][golang-style-doc] for details.
38+
The coding style suggested by the Java community is used in Java operator. See the [style doc](https://google.github.io/styleguide/javaguide.html) for details.
2939

3040
Please follow this style to make operator-sdk easy to review, maintain and develop.
3141

@@ -55,6 +65,14 @@ The format can be described more formally as follows:
5565

5666
The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
5767

68+
### PR Review
69+
70+
Your PR will get reviewed soon from the maintainers of the project. If they suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If all is fine, your PR will be merged.
71+
72+
That's it! Thank you for your contribution!
73+
74+
Feel free to suggest changes to this documentation. If you want to discuss something with maintainers, you can ask us on a GitHub [issue](https://github.com/operator-framework/java-operator/issues)
75+
5876
## Documentation
5977

60-
If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature.
78+
If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature.

0 commit comments

Comments
 (0)