Skip to content

Commit c7aee38

Browse files
committed
Update the CONTRIBUTING.md guidelines
Signed-off-by: timflannagan <[email protected]>
1 parent b849eb7 commit c7aee38

File tree

1 file changed

+34
-11
lines changed

1 file changed

+34
-11
lines changed

Diff for: CONTRIBUTING.md

+34-11
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# How to contribute
22

3-
Operator Lifecycle Manager 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-lifecycle-manager.
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.
44

5-
# Email and Chat
5+
## Communication
66

7-
- Email: [operator-framework][operator_framework]
7+
- Email: [operator-framework][operator_framework]
8+
- Slack: [#olm-dev][olm-dev]
9+
- Working Group: [olm-wg][olm-wg]
810

911
## Getting started
1012

@@ -13,31 +15,52 @@ Operator Lifecycle Manager is Apache 2.0 licensed and accepts contributions via
1315

1416
## Reporting bugs and creating issues
1517

16-
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. This document might contain links to known issues, another good reason to take a look there before reporting a bug.
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].
19+
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.
1721

1822
## Contribution flow
1923

2024
This is a rough outline of what a contributor's workflow looks like:
2125

22-
- Create a topic branch from where to base the contribution. This is usually master.
26+
- Identify or create an issue.
27+
- Create a topic branch from where to base the contribution. This is usually the master branch.
2328
- Make commits of logical units.
2429
- Make sure commit messages are in the proper format (see below).
30+
- Ensure all relevant commit messages contain a valid sign-off message (see below).
2531
- Push changes in a topic branch to a personal fork of the repository.
26-
- Submit a pull request to operator-framework/operator-lifecycle-manager.
27-
- The PR must receive a LGTM from two maintainers found in the MAINTAINERS file.
32+
- Submit a pull request to the operator-framework/operator-lifecycle-manager repository.
33+
- Wait and respond to feedback from the maintainers listed in the OWNERS file.
2834

2935
Thanks for contributing!
3036

37+
### Code Review
38+
39+
Each PR must be labeled with at least one "lgtm" label and at least one "approved" label before it can be merged.
40+
41+
Maintainers that have approval permissions are listed in the "approvers" column in the root [OWNERS][owners] file.
42+
3143
### Code style
3244

33-
The coding style suggested by the Golang community is used in operator-lifecycle-manager. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details.
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.
46+
47+
Please follow this style to make the operator-lifecycle-manager project easier to review, maintain and develop.
48+
49+
### Sign-off ([DCO][DCO])
3450

35-
Please follow this style to make operator-lifecycle-manager easy to review, maintain and develop.
51+
A [sign-off][sign-off] is a line towards the end of a commit message that certifies the commit author(s).
3652

3753
## Documentation
3854

39-
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. Likewise the [CHANGELOG][changelog] should be updated with a summary of the change and link to the pull request.
55+
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.
4056

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

4259
[operator_framework]: https://groups.google.com/forum/#!forum/operator-framework
43-
[changelog]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/CHANGELOG.md
60+
[dco]: <https://developercertificate.org/>
61+
[owners]: <https://github.com/operator-framework/operator-lifecycle-manager/blob/master/OWNERS>
62+
[issues]: <https://github.com/operator-framework/operator-lifecycle-manager/issues>
63+
[olm-docs]: <https://github.com/operator-framework/olm-docs>
64+
[olm-dev]: <https://kubernetes.slack.com/archives/C0181L6JYQ2>
65+
[olm-wg]: <https://docs.google.com/document/d/1Zuv-BoNFSwj10_zXPfaS9LWUQUCak2c8l48d0-AhpBw/edit?usp=sharing>
66+
[sign-off]: <https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff>

0 commit comments

Comments
 (0)