-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Devtools Week] Update contributing guide (#67)
* add missing DCO file Signed-off-by: Michael Valdron <[email protected]> * contributing guide revisions Signed-off-by: Michael Valdron <[email protected]> --------- Signed-off-by: Michael Valdron <[email protected]>
- Loading branch information
1 parent
deec778
commit cb5c55e
Showing
2 changed files
with
60 additions
and
10 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,13 +6,28 @@ Thank you for your interest in contributing to the Devfile Registry Operator! We | |
|
||
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) | ||
|
||
## 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 | ||
|
||
If you spot a problem with the devfile registry, [search if an issue already exists](https://github.com/devfile/api/issues). 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). | ||
If you spot a problem with the **devfile registry operator**, [search if an issue already exists](https://github.com/devfile/api/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fregistry). | ||
|
||
You can tag Devfile Registry related issues with the `/area registry` text in your issue. | ||
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 Devfile Registry Operator related issues with the `/area registry` text in your issue. | ||
|
||
### Development | ||
|
||
|
@@ -50,7 +65,7 @@ If you want to enable http/2 for the webhook server, build with `ENABLE_WEBHOOK_ | |
|
||
### Testing your Changes | ||
|
||
All changes delivered to the Devfile Registry operator are expected to be sufficiently tested. This may include validating that existing tests pass, updating tests, or adding new tests. | ||
All changes delivered to the Devfile Registry Operator are expected to be sufficiently tested. This may include validating that existing tests pass, updating tests, or adding new tests. | ||
|
||
#### Unit Tests | ||
|
||
|
@@ -60,14 +75,13 @@ The unit tests for this repository are located under the `pkg/` folder and are d | |
|
||
The integration tests for this repository are located under the `tests/integration` folder and contain tests that validate the Operator's functionality when running on an OpenShift cluster. | ||
|
||
To run these tests, run the following commands : | ||
To run these tests, run the following commands: | ||
|
||
```bash | ||
export IMG=<your-built-operator-image> | ||
make test-integration | ||
``` | ||
|
||
|
||
### Submitting Pull Request | ||
|
||
**Note:** All commits must be signed off with the footer: | ||
|
@@ -77,15 +91,14 @@ Signed-off-by: First Lastname <[email protected]> | |
|
||
You can easily add this footer to your commits by adding `-s` when running `git commit`. 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. | ||
Owners of the repository will watch out for new PRs and provide reviews to them. | ||
|
||
By default for each change in the PR, GitHub Actions and OpenShift CI will run checks against your changes (linting, unit testing, and integration tests) | ||
For each change in the PR, GitHub Actions and OpenShift CI will by default run checks against your changes (linting, unit testing, and integration tests). | ||
|
||
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 afterward, so everyone gets notified by Github and knows to re-review. | ||
|
||
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. | ||
|
||
# Contact us | ||
|
||
If you have questions, please visit us on `#devfile` on the [Kubernetes Slack](https://slack.k8s.io). | ||
If you have any questions, please visit the `#devfile` channel under the [Kubernetes Slack](https://slack.k8s.io) workspace. |
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,37 @@ | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
|
||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
1 Letterman Drive | ||
Suite D4700 | ||
San Francisco, CA, 94129 | ||
|
||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
|
||
|
||
Developer's Certificate of Origin 1.1 | ||
|
||
By making a contribution to this project, I certify that: | ||
|
||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
|
||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
|
||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
|
||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. |