Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Devtools Week] Update contributing guide #194

Merged
merged 8 commits into from
Dec 15, 2023
Merged

[Devtools Week] Update contributing guide #194

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4325c1e
Add only default tags in index component (#9)
thepetk Dec 5, 2023
f39a562
Update test cases
thepetk Dec 5, 2023
1fc7b97
Fix test cases typo
thepetk Dec 5, 2023
e18ee2e
Fix tags in index_extra.json
thepetk Dec 5, 2023
7127893
Finalize test cases fixes
thepetk Dec 5, 2023
4f4ba1e
Merge branch 'devfile:main' into main
thepetk Dec 12, 2023
c7ecdd1
Update registry support contributing guide
thepetk Dec 12, 2023
405a715
Update contributing guide
thepetk Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for your interest in contributing to the Devfile Registry! We welcome

## Code of Conduct

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

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

### 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, [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).

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

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

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.


#### Building All Components Together

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
Expand All @@ -59,21 +58,21 @@ To run these tests, consult the integration test's [readme](./tests/integration)
### Submitting Pull Request

**Note:** All commits must be signed off with the footer:

```
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 run by default 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 know 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` in the [Kubernetes Slack](https://slack.k8s.io).
If you have any questions, please visit us the `#devfile` channel under the [Kubernetes Slack](https://slack.k8s.io) workspace.
Loading