-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add contribution guideline #58
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.
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
9661dfd
feat: add contribution guidelines
lukasmetzner e3d10ba
fix: bullet point list on same line
lukasmetzner 365445e
fix: PR title requirements
lukasmetzner ff50a89
docs: apply suggestions
lukasmetzner 3869071
fix: ci errors must be fixed
lukasmetzner c99e286
fix: clear up ai assistant requirements
lukasmetzner 876b1fe
style: wording about reporter CI errors
jooola b24227e
style: PR => pull request
jooola f46528d
style: update title and add friendly intro
jooola c4f7ec7
fix: typo
lukasmetzner 5ff7f85
style: typo
jooola 4d87fb4
style: make ai policy an unordered list
lukasmetzner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| # Contribution Guideline | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project follows the core values of the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/3/0/code_of_conduct/). | ||
|
|
||
| ## Reporting a bug | ||
|
|
||
| 1. **Check first** that the bug isn't already filed — search both open and | ||
| closed issues. If you find a match, add a 👍 reaction or a comment with new | ||
| information rather than opening a duplicate. | ||
| 2. **Use the issue template** for the relevant repo. | ||
|
|
||
| ## Proposing a change | ||
|
|
||
| The kinds of pull requests we welcome: | ||
|
|
||
| - **Bug fixes** for clearly identified bugs. The PR description should explain | ||
|
lukasmetzner marked this conversation as resolved.
Outdated
|
||
| what is being fixed and how to verify it. A regression test is expected. | ||
|
lukasmetzner marked this conversation as resolved.
Outdated
|
||
| - **New features** that solve a use case shared by a meaningful portion of users. | ||
| **Please open an issue first** and wait for a maintainer to confirm the direction before writing code. | ||
| - **Chores**: typos, comment clarifications. | ||
| Multiple typo or comment fixes can be combined into a single PR. | ||
|
lukasmetzner marked this conversation as resolved.
Outdated
|
||
|
|
||
| What we'll generally **decline**: | ||
|
|
||
| - Stylistic refactors that don't improve performance, correctness, or | ||
| testability. Code style is subjective and large diffs make `git blame` worse. | ||
| We're happy to accept small, principled cleanups alongside other work. | ||
| - Changes which result in a breaking change. | ||
| - "Drive-by" PRs where the contributor isn't available to address review | ||
|
lukasmetzner marked this conversation as resolved.
Outdated
|
||
| comments. | ||
|
|
||
| ## Pull request guidelines | ||
|
|
||
| - **One concern per PR.** Smaller PRs get faster reviews. | ||
|
lukasmetzner marked this conversation as resolved.
Outdated
|
||
| - **Tests are required** for bug fixes (regression test) and new features | ||
| (coverage of the new path). | ||
| - **CI must be green** before a PR is merged. If a CI failure looks unrelated | ||
| to your change, comment on the PR rather than force-pushing — a maintainer | ||
| will have a look. | ||
| - ⚠️ A lot of our e2e tests use the [tps-action](https://github.com/hetznercloud/tps-action). This action will fail for unauthorized users. Expect them to fail, if you are not part of our organization. A maintainer will run the e2e tests. If you decide on running them on your own costs, feel free to share the results. | ||
| - **Allow edits from maintainers** when you open the PR, so we can rebase or | ||
| make small fixups directly. | ||
| - **Don't force-push** after a maintainer has started reviewing. Push new | ||
| commits; we squash on merge. | ||
| - **PR titles** should follow the [Conventional Commits](https://www.conventionalcommits.org/) pattern because the title becomes the squash-merge commit message (see [Commit messages](#commit-messages) for details); update the title and body if the change drifts during review. | ||
|
lukasmetzner marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Commit messages | ||
|
|
||
| We use [Conventional Commits](https://www.conventionalcommits.org/). The format matters because [releaser-pleaser](https://github.com/apricote/releaser-pleaser) generates our changelogs from it. | ||
|
|
||
| ``` | ||
| <type>(<optional scope>): <short imperative summary, ≤72 chars> | ||
|
|
||
| <optional longer body explaining the why, wrapped at ~72 chars> | ||
|
|
||
| <optional footers, e.g. Fixes #123, BREAKING CHANGE: ...> | ||
| ``` | ||
|
|
||
| Common types: `feat`, `fix`, `chore`, `docs`, `test`, `refactor`, `ci`, `build`. | ||
| A `feat:` triggers a minor release, a `fix:` triggers a patch release. | ||
|
|
||
| Examples: | ||
|
|
||
| - `feat(server-type): add support for ARM64 server types` | ||
| - `fix(load-balancer): retry transient 503s from the API` | ||
| - `docs: clarify token scopes in README` | ||
|
|
||
| ## AI / LLM policy | ||
|
|
||
| You may use AI assistants when contributing, subject to all the following: | ||
|
jooola marked this conversation as resolved.
Outdated
|
||
|
|
||
| 1. **Disclose** in the PR description (or issue) that you used an AI tool, and | ||
| which one. One short line is enough. | ||
| 2. **You are accountable.** You must understand every change you submit well | ||
| enough to explain it, defend it in review, and revise it without further AI | ||
| help if the reviewer asks. PRs from contributors who can't engage with | ||
| review comments will be closed. | ||
| 3. **Submitted by a human.** PRs must come from a real, human-owned GitHub | ||
| account. We don't accept submissions from bot accounts or unattended agents. | ||
| 4. **Quality bar is unchanged.** AI-generated boilerplate, half-finished code, | ||
| plausible-but-wrong fixes, or hallucinated APIs will be closed. | ||
| 5. **Cap on open AI-assisted PRs.** Contributors may have at most | ||
| two open AI-assisted PR(s) at a time. This protects review | ||
| capacity. Maintainers are not subject to this cap. | ||
|
|
||
| ## Licensing | ||
|
|
||
| By submitting a contribution, you agree that it is licensed under the same | ||
| licence as the repository you're contributing to. See each repo's `LICENSE` | ||
|
lukasmetzner marked this conversation as resolved.
Outdated
|
||
| file. | ||
|
|
||
| Thanks for contributing. If something in these guidelines is unclear or seems | ||
| to be missing, please open an issue or PR — they apply to themselves. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.