-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Michael Valdron <[email protected]>
- Loading branch information
1 parent
cfbdc2b
commit 2b8758d
Showing
1 changed file
with
38 additions
and
15 deletions.
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. | ||
|
|
||
| ### 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. | ||