|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -Contributions are welcome! |
| 3 | +Thank you for your interest in contributing to the Devfile Web! We welcome your additions to this project. |
4 | 4 |
|
5 | 5 | ## Code of Conduct
|
6 | 6 |
|
|
22 | 22 |
|
23 | 23 | Once you set your user.name and user.email in your git config, you can sign your commit automatically with `git commit -s`.
|
24 | 24 |
|
25 |
| -## Getting Started |
| 25 | +## How to Contribute: |
26 | 26 |
|
27 | 27 | ### Issues
|
28 | 28 |
|
29 |
| -- Issues are tracked via the the [devfile/api](https://github.com/devfile/api) repo. Open or search for [issues](https://github.com/devfile/api/issues) with the label `area/landing-page`. |
| 29 | +- If you spot a problem with the **landing page**, [search if an issue already exists](https://github.com/devfile/api/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Flanding-page). |
30 | 30 |
|
31 |
| -- 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 issues with `/area landing-page`. |
| 31 | +- If you spot a problem with the **registry viewer**, [search if an issue already exists](https://github.com/devfile/api/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fregistry-viewer). |
32 | 32 |
|
33 |
| -### Pull Requests |
| 33 | +If a related issue doesn't exist, you can open a new issue using the [issue form](https://github.com/devfile/api/issues/new/choose). You can tag `landing page` related issues with the `/area landing-page` and `registry viewer` with the `area/registry-viewer` text in your issue. |
| 34 | + |
| 35 | +### Submitting Pull Request |
34 | 36 |
|
35 | 37 | When you think the code is ready for review, create a pull request and link the issue associated with it.
|
36 | 38 |
|
37 |
| -Owners of the repository will watch out for and review new PRs. |
| 39 | +Owners of the repository will watch out for new PRs and provide reviews to them. |
38 | 40 |
|
39 | 41 | If comments have been given in a review, they have to be addressed before merging.
|
40 | 42 |
|
41 |
| -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. |
| 43 | +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. |
42 | 44 |
|
43 | 45 | ## Troubleshooting
|
44 | 46 |
|
45 |
| -- There is a known issue with Apple Silicon (arm64) architectures that may cause the `build_viewer.sh` script to fail. If this issue occurs first run `export PLATFORM_EV=linux/arm64`. |
| 47 | +- There is a known issue with Apple Silicon (arm64) architectures that may cause the `build_viewer.sh` script to fail. If this issue occurs first run `export PLATFORM_EV=linux/arm64`. |
| 48 | + |
| 49 | +# Contact us |
| 50 | + |
| 51 | +If you have any questions, please visit us the `#devfile` channel under the [Kubernetes Slack](https://slack.k8s.io) workspace. |
0 commit comments