-
Notifications
You must be signed in to change notification settings - Fork 64
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
Update contributing guide #1597
Merged
michael-valdron
merged 4 commits into
devfile:main
from
michael-valdron:chore/update-contributing
Jun 14, 2024
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 |
---|---|---|
|
@@ -6,14 +6,49 @@ Contributions are welcome! | |
|
||
Before contributing to this repository for the first time, please review our project's [Code of Conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md). | ||
|
||
## Getting Started | ||
## Certificate of Origin | ||
|
||
By contributing to this project you agree to the Developer Certificate of | ||
Origin (DCO). This document was created by the Linux Kernel community and is a | ||
simple statement that you, as a contributor, have the legal right to make the | ||
contribution. See the [DCO](DCO) file for details. | ||
|
||
In order to show your agreement with the DCO you should include at the end of the commit message, | ||
the following line: | ||
|
||
```console | ||
Signed-off-by: Firstname Lastname <[email protected]> | ||
``` | ||
|
||
Once you set your user.name and user.email in your git config, you can sign your commit automatically with `git commit -s`. | ||
|
||
## How to Contribute: | ||
|
||
### Issues | ||
|
||
- Open or search for [issues](https://github.com/devfile/api/issues) with the label `area/api`. | ||
|
||
- If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/devfile/api/issues/new/choose). You can tag issues with `/area api`. | ||
|
||
### Submitting Pull Request | ||
|
||
When you think the code is ready for review, create a pull request and link the issue associated with it. | ||
|
||
Owners of the repository will watch out for new PRs and provide reviews to them. | ||
|
||
If comments have been given in a review, they have to be addressed before merging. | ||
|
||
After addressing review comments, don't forget to add a comment in the PR with the reviewer mentioned afterward, so they get notified by Github to provide a re-review. | ||
thepetk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Prerequisites | ||
|
||
The following are required to build the CRDs and TypeScript models containing your changes: | ||
|
||
- Docker or Podman | ||
- Git | ||
|
||
Testing requires Go 1.21+ to be installed. | ||
|
||
### Building | ||
|
||
To build the CRD and the various schemas, you don't need to install any pre-requisite apart from `docker` or `podman`. | ||
|
@@ -48,18 +83,6 @@ cd test/v200/apiTest | |
go test -v | ||
``` | ||
|
||
### Pull Requests | ||
|
||
All commits must be signed off with the footer: | ||
|
||
```git | ||
Signed-off-by: Firstname Lastname <[email protected]> | ||
``` | ||
|
||
Once you set your user.name and user.email in your git config, you can sign your commit automatically with git commit -s. When you think the code is ready for review, create a pull request and link the issue associated with it. | ||
|
||
Owners of the repository will watch out for and review new PRs. | ||
|
||
If comments have been given in a review, they have to be addressed before merging. | ||
# Contact us | ||
|
||
After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review. | ||
If you have any questions, please visit us the `#devfile` channel under the [Kubernetes Slack](https://slack.k8s.io) workspace. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @yangcao77 @thepetk How is this change? aa7e5b3 |
Oops, something went wrong.
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.
invalid link for DCO file
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.
fixed in fd6dd3f, missed that this repository was also missing the
DCO
file.