-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
project: Add CONTRIBUTING and OWNERS files #3
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
# How to Contribute | ||
|
||
The lvm-operator project is under the [Apache 2.0 license](LICENSE). We accept | ||
contributions via GitHub pull requests. This document outlines how to | ||
contribute to the project. | ||
|
||
## Contribution Flow | ||
|
||
Developers must follow these steps to make a change: | ||
|
||
1. Fork the `red-hat-storage/lvm-operator` repository on GitHub. | ||
2. Create a branch from the `main` branch, or from a versioned branch (such | ||
as `release-4.9`) if you are proposing a backport. | ||
3. Make changes. | ||
4. Create tests as needed and ensure that all tests pass. | ||
5. Push your changes to a branch in your fork of the repository. | ||
6. Submit a pull request to the `red-hat-storage/lvm-operator` repository. | ||
7. Work with the community to make any necessary changes through the code | ||
review process (effectively repeating steps 3-7 as needed). | ||
|
||
|
||
## Developer Environment Installation | ||
ToDo | ||
|
||
|
||
## Commits Per Pull Request | ||
|
||
Pull requests should always represent a complete logical change. Where | ||
possible, though, pull requests should be composed of multiple commits that | ||
each make small but meaningful changes. Striking a balance between minimal | ||
commits and logically complete changes is an art as much as a science, but | ||
when it is possible and reasonable, divide your pull request into more commits. | ||
|
||
Some times when it will almost always make sense to separate parts of a change | ||
into their own commits are: | ||
- Changes to unrelated formatting and typo-fixing. | ||
- Refactoring changes that prepare the codebase for your logical change. | ||
|
||
Even when breaking down commits, each commit should leave the codebase in a | ||
working state. The code should add necessary unit tests and pass unit tests, | ||
formatting tests, and usually functional tests. There can be times when | ||
exceptions to these requirements are appropriate (for instance, it is sometimes | ||
useful for maintainability to split code changes and related changes to CRDs | ||
and CSVs). Unless you are very sure this is true for your change, though, make | ||
sure each commit passes CI checks as above. | ||
|
||
Make sure to update the bundle manifests after making changes, in a separate | ||
commit using: | ||
``` | ||
make bundle | ||
``` | ||
|
||
## Commit structure | ||
|
||
LVM Operator maintainers value clear and explanatory commit messages. So by default | ||
each of your commits must follow the rules below: | ||
|
||
### We follow the common commit conventions | ||
``` | ||
type: subject | ||
|
||
body? | ||
|
||
footer? | ||
``` | ||
|
||
### Here is an example of an acceptable commit message for a bug fix: | ||
``` | ||
component: commit title | ||
|
||
This is the commit message, where I'm explaining what the bug was, along | ||
with its root cause. | ||
Then I'm explaining how I fixed it. | ||
|
||
Fix: https://bugzilla.redhat.com/show_bug.cgi?id=<NUMBER> | ||
|
||
Signed-off-by: First_Name Last_Name <email address> | ||
``` | ||
|
||
### Here is an example of an acceptable commit message for a new feature: | ||
``` | ||
component: commit title | ||
|
||
This is the commit message, here I'm explaining, what this feature is | ||
and why do we need it. | ||
|
||
Signed-off-by: First_Name Last_Name <email address> | ||
``` | ||
|
||
|
||
### More Guidelines: | ||
- Type/component should not be empty. | ||
- Your commit msg should not exceed more than 72 characters per line. | ||
- Header should not have a full stop. | ||
- Body should always end with the full stop. | ||
- There should be one blank line in b/w header and body. | ||
- There should be one blank line in b/w body and footer. | ||
- Your commit message must be signed-off. | ||
- *Recommendation*: A "Co-authored-by:" line should be added for each | ||
additional author. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# approval == this is a good idea /approve | ||
approvers: | ||
- nbalach | ||
# review == this code is good /lgtm | ||
reviewers: | ||
- nbalacha | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It will be good to add more people to that list. Such as @leelavg @rohantmp @sp98.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They will be added later. This is an initial file PR.