You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-10Lines changed: 23 additions & 10 deletions
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
6
6
7
7
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)
8
8
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,
Once you set your user.name and user.email in your git config, you can sign your commit automatically with `git commit -s`.
23
+
9
24
## How to Contribute
10
25
11
26
### Issues
12
27
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).
14
29
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.
16
31
17
32
### Development
18
33
@@ -50,7 +65,7 @@ If you want to enable http/2 for the webhook server, build with `ENABLE_WEBHOOK_
50
65
51
66
### Testing your Changes
52
67
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.
54
69
55
70
#### Unit Tests
56
71
@@ -60,14 +75,13 @@ The unit tests for this repository are located under the `pkg/` folder and are d
60
75
61
76
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.
62
77
63
-
To run these tests, run the following commands:
78
+
To run these tests, run the following commands:
64
79
65
80
```bash
66
81
export IMG=<your-built-operator-image>
67
82
make test-integration
68
83
```
69
84
70
-
71
85
### Submitting Pull Request
72
86
73
87
**Note:** All commits must be signed off with the footer:
@@ -77,15 +91,14 @@ Signed-off-by: First Lastname <email@email.com>
77
91
78
92
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.
79
93
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.
81
95
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).
83
97
84
98
If comments have been given in a review, they have to be addressed before merging.
85
99
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.
88
101
89
102
# Contact us
90
103
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.
0 commit comments