Skip to content

Commit cb5c55e

Browse files
[Devtools Week] Update contributing guide (#67)
* add missing DCO file Signed-off-by: Michael Valdron <mvaldron@redhat.com> * contributing guide revisions Signed-off-by: Michael Valdron <mvaldron@redhat.com> --------- Signed-off-by: Michael Valdron <mvaldron@redhat.com>
1 parent deec778 commit cb5c55e

File tree

2 files changed

+60
-10
lines changed

2 files changed

+60
-10
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,28 @@ Thank you for your interest in contributing to the Devfile Registry Operator! We
66

77
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)
88

9+
## Certificate of Origin
10+
11+
By contributing to this project you agree to the Developer Certificate of
12+
Origin (DCO). This document was created by the Linux Kernel community and is a
13+
simple statement that you, as a contributor, have the legal right to make the
14+
contribution. See the [DCO](DCO) file for details.
15+
16+
In order to show your agreement with the DCO you should include at the end of the commit message,
17+
the following line:
18+
```console
19+
Signed-off-by: Firstname Lastname <email@email.com>
20+
```
21+
22+
Once you set your user.name and user.email in your git config, you can sign your commit automatically with `git commit -s`.
23+
924
## How to Contribute
1025

1126
### Issues
1227

13-
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).
28+
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).
1429

15-
You can tag Devfile Registry related issues with the `/area registry` text in your issue.
30+
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.
1631

1732
### Development
1833

@@ -50,7 +65,7 @@ If you want to enable http/2 for the webhook server, build with `ENABLE_WEBHOOK_
5065

5166
### Testing your Changes
5267

53-
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.
68+
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.
5469

5570
#### Unit Tests
5671

@@ -60,14 +75,13 @@ The unit tests for this repository are located under the `pkg/` folder and are d
6075

6176
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.
6277

63-
To run these tests, run the following commands :
78+
To run these tests, run the following commands:
6479

6580
```bash
6681
export IMG=<your-built-operator-image>
6782
make test-integration
6883
```
6984

70-
7185
### Submitting Pull Request
7286

7387
**Note:** All commits must be signed off with the footer:
@@ -77,15 +91,14 @@ Signed-off-by: First Lastname <email@email.com>
7791

7892
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.
7993

80-
Owners of the repository will watch out for and review new PRs.
94+
Owners of the repository will watch out for new PRs and provide reviews to them.
8195

82-
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)
96+
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).
8397

8498
If comments have been given in a review, they have to be addressed before merging.
8599

86-
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.
87-
100+
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.
88101

89102
# Contact us
90103

91-
If you have questions, please visit us on `#devfile` on the [Kubernetes Slack](https://slack.k8s.io).
104+
If you have any questions, please visit the `#devfile` channel under the [Kubernetes Slack](https://slack.k8s.io) workspace.

DCO

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
1 Letterman Drive
6+
Suite D4700
7+
San Francisco, CA, 94129
8+
9+
Everyone is permitted to copy and distribute verbatim copies of this
10+
license document, but changing it is not allowed.
11+
12+
13+
Developer's Certificate of Origin 1.1
14+
15+
By making a contribution to this project, I certify that:
16+
17+
(a) The contribution was created in whole or in part by me and I
18+
have the right to submit it under the open source license
19+
indicated in the file; or
20+
21+
(b) The contribution is based upon previous work that, to the best
22+
of my knowledge, is covered under an appropriate open source
23+
license and I have the right under that license to submit that
24+
work with modifications, whether created in whole or in part
25+
by me, under the same open source license (unless I am
26+
permitted to submit under a different license), as indicated
27+
in the file; or
28+
29+
(c) The contribution was provided directly to me by some other
30+
person who certified (a), (b) or (c) and I have not modified
31+
it.
32+
33+
(d) I understand and agree that this project and the contribution
34+
are public and that a record of the contribution (including all
35+
personal information I submit with it, including my sign-off) is
36+
maintained indefinitely and may be redistributed consistent with
37+
this project or the open source license(s) involved.

0 commit comments

Comments
 (0)