Skip to content

Commit 35722ec

Browse files
authored
[Devtools Week] Update contributing guide (#194)
* Add only default tags in index component (#9) Signed-off-by: thepetk <[email protected]> * Update test cases Signed-off-by: thepetk <[email protected]> * Fix test cases typo Signed-off-by: thepetk <[email protected]> * Fix tags in index_extra.json Signed-off-by: thepetk <[email protected]> * Finalize test cases fixes Signed-off-by: thepetk <[email protected]> * Update registry support contributing guide Signed-off-by: thepetk <[email protected]> * Update contributing guide Signed-off-by: thepetk <[email protected]> --------- Signed-off-by: thepetk <[email protected]>
1 parent 321dced commit 35722ec

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thank you for your interest in contributing to the Devfile Registry! We welcome
44

55
## Code of Conduct
66

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

99
## Certificate of Origin
1010

@@ -17,7 +17,7 @@ contribution. See the [DCO](./DCO) file for details.
1717

1818
### Issues
1919

20-
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).
20+
If you spot a problem with the devfile registry, [search if an issue already exists](https://github.com/devfile/api/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fregistry). 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).
2121

2222
You can tag Devfile Registry related issues with the `/area registry` text in your issue.
2323

@@ -35,7 +35,6 @@ The `registry-support` repository for the devfile registry is a mono-repo of sor
3535

3636
Each of these individual components will have their own readme with instructions for consuming or developing the component, and it's recommended to consult them before development.
3737

38-
3938
#### Building All Components Together
4039

4140
This repository contains a handy script that will build all of the individual components of the devfile registry (build-tools, index generator, index server, registry viewer, etc) and produce a deployable
@@ -59,21 +58,21 @@ To run these tests, consult the integration test's [readme](./tests/integration)
5958
### Submitting Pull Request
6059

6160
**Note:** All commits must be signed off with the footer:
61+
6262
```
6363
Signed-off-by: First Lastname <[email protected]>
6464
```
6565

6666
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.
6767

68-
Owners of the repository will watch out for and review new PRs.
68+
Owners of the repository will watch out for new PRs and provide reviews to them.
6969

70-
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).
70+
For each change in the PR, GitHub Actions and OpenShift CI will run by default checks against your changes (linting, unit testing, and integration tests).
7171

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

74-
After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and know to re-review.
75-
74+
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.
7675

7776
# Contact us
7877

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

0 commit comments

Comments
 (0)