|
1 | | -## Contribution Guidelines |
| 1 | +# Contribution Guidelines |
2 | 2 |
|
3 | | -- **To add, remove, or change things on the list:** Submit a pull request |
4 | | -- List items should be sorted *alphabetically*. |
5 | | -- Each item should be limited to one link. |
6 | | -- The link should be the name of the package or project. |
7 | | -- The project should be hosted on GitHub. |
8 | | -- Descriptions should be clear, concise, and non-promotional. |
9 | | -- Descriptions should follow the link, on the same line and end with a punctuation mark. |
| 3 | +Thanks for helping keep this Kubernetes and cloud-native catalog sharp. Please follow the rules below so the list stays consistent and searchable. |
| 4 | + |
| 5 | +## General expectations |
| 6 | + |
| 7 | +- Additions **must be open source** (ideally GitHub-hosted) and clearly benefit cloud-native workloads. |
| 8 | +- Place each project in the **single best matching top-level category** from the table of contents. If unsure, explain the rationale in the PR description. |
| 9 | +- Keep descriptions on a single line, start with sentence case, and avoid marketing fluff. |
| 10 | +- Use the official project name as the link text and point directly to the canonical repository. |
| 11 | + |
| 12 | +## Ordering & formatting |
| 13 | + |
| 14 | +- Categories and items are maintained in **alphabetical order**. Run `go test ./...` (see below) before submitting; it will fail if ordering or duplicates are wrong. |
| 15 | +- One entry per project. Remove retired or duplicate links when encountered. |
| 16 | +- New entries go directly under the relevant `##` heading with a trailing period only if the sentence is complete. |
| 17 | + |
| 18 | +## Local checks before PR |
| 19 | + |
| 20 | +1. `gofmt -w repo.go repo_test.go` (only needed if you touched Go files). |
| 21 | +2. `go test ./...` – verifies alphabetical ordering and ensures no duplicate links. |
| 22 | +3. `go run ./repo.go` – regenerates `tmpl/index.html`; run this whenever README content changes so the published site stays in sync. |
| 23 | + |
| 24 | +Include the commands you ran in your pull request description. |
10 | 25 |
|
11 | 26 | ## Reporting issues |
12 | 27 |
|
13 | | -Please open an issue if you would like to discuss anything that could be improved or have suggestions for making the list a more valuable resource. We realize sometimes packages fall into abandonment or have breaking builds for extended periods of time, so if you see that, feel free to change its listing or let us know. We also realize that sometimes projects are just going through transitions or are more experimental in nature. These can still be cool, but we can indicate them as transitory or experimental. |
| 28 | +Open an issue when you find outdated, broken, or abandoned projects, or when you’d like to propose a new category. Provide links or context so maintainers can validate quickly. |
14 | 29 |
|
15 | | -Thank you for your contribution! |
| 30 | +Thanks again for contributing! |
0 commit comments