Skip to content

Commit 35694e0

Browse files
committed
Address review feedback
Signed-off-by: timflannagan <[email protected]>
1 parent 352d43b commit 35694e0

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

CONTRIBUTING.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How to contribute
22

3-
Operator Lifecycle Manager is an Apache 2.0 licensed project 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 operator-lifecycle-manager project.
3+
Operator Lifecycle Manager (OLM) is an Apache 2.0 licensed project 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 OLM project.
44

55
## Communication
66

@@ -15,9 +15,9 @@ Operator Lifecycle Manager is an Apache 2.0 licensed project and accepts contrib
1515

1616
## Reporting bugs and creating issues
1717

18-
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 bugs](./doc/dev/reporting_bugs.md) before submitting a bug report. Before filing a bug report, ensure the bug hasn't already been reported by searching through the operator-lifecycle-manager project [Issues][issues].
18+
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 bugs](./doc/dev/reporting_bugs.md) before submitting a bug report. Before filing a bug report, ensure the bug hasn't already been reported by searching through the OLM project [Issues][issues].
1919

20-
Any new contribution should be accompanied by a new or existing issue. This issue can help track work, discuss the design and implementation, and help avoid wasted efforts or multiple people working on the same issue, compared to submitting a PR first. Trivial changes, like fixing a typo in the documentation, do not require the creation of a new issue. Proposing larger changes to the operator-lifecycle-manager project may require an enhancement be created in the [operator-framework/enhancements](https://github.com/operator-framework/enhancements/) repository.
20+
Any new contribution should be accompanied by a new or existing issue. This issue can help track work, discuss the design and implementation, and help avoid wasted efforts or multiple people working on the same issue, compared to submitting a PR first. Trivial changes, like fixing a typo in the documentation, do not require the creation of a new issue. Proposing larger changes to the OLM project may require an enhancement be created in the [operator-framework/enhancements](https://github.com/operator-framework/enhancements/) repository.
2121

2222
## Contribution flow
2323

@@ -36,25 +36,33 @@ Thanks for contributing!
3636

3737
### Code Review
3838

39+
<!--
40+
TODO(tflannag): Call out the need to run `make verify` locally for relevant codepaths.
41+
-->
42+
3943
Each PR must be labeled with at least one "lgtm" label and at least one "approved" label before it can be merged.
4044

4145
Maintainers that have approval permissions are listed in the "approvers" column in the root [OWNERS][owners] file.
4246

4347
### Code style
4448

45-
The coding style suggested by the Golang community is used in the operator-lifecycle-manager project. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details.
49+
The coding style suggested by the Golang community is used in the OLM project. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details.
50+
51+
In addition to the linked style documentation, OLM formats Golang packages using the `go fmt` tool. Before submitting a PR, please run `go fmt ...` on relevant packages and commit the results. This will help expedite the review process, focusing less on style conflicts, and more on the design and implementation details.
4652

47-
Please follow this style to make the operator-lifecycle-manager project easier to review, maintain and develop.
53+
Please follow this style to make the OLM project easier to review, maintain and develop.
4854

4955
### Sign-off ([DCO][DCO])
5056

5157
A [sign-off][sign-off] is a line towards the end of a commit message that certifies the commit author(s).
5258

59+
For more information on the structuring of commit messages, read the information in the [DCO][https://github.com/apps/dco] application that the OLM projects uses.
60+
5361
## Documentation
5462

5563
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.
5664

57-
The operator-lifecycle-manager documentation mainly lives in the [operator-framework/olm-docs][olm-docs] repository.
65+
The OLM documentation mainly lives in the [operator-framework/olm-docs][olm-docs] repository.
5866

5967
[operator_framework]: https://groups.google.com/forum/#!forum/operator-framework
6068
[dco]: <https://developercertificate.org/>

0 commit comments

Comments
 (0)