Skip to content

Commit 1855d5c

Browse files
lukasmetznerjooola
andauthored
docs: apply suggestions
Co-authored-by: Jonas L. <jooola@users.noreply.github.com>
1 parent 365445e commit 1855d5c

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,31 @@ This project follows the core values of the [Contributor Covenant Code of Conduc
99
1. **Check first** that the bug isn't already filed — search both open and
1010
closed issues. If you find a match, add a 👍 reaction or a comment with new
1111
information rather than opening a duplicate.
12-
2. **Use the issue template** for the relevant repo.
12+
2. **Use the issue template** when opening an issue.
1313

1414
## Proposing a change
1515

1616
The kinds of pull requests we welcome:
1717

18-
- **Bug fixes** for clearly identified bugs. The PR description should explain
18+
- **Bug fixes** for clearly identified bugs. The pull request description should explain
1919
what is being fixed and how to verify it. A regression test is expected.
2020
- **New features** that solve a use case shared by a meaningful portion of users.
2121
**Please open an issue first** and wait for a maintainer to confirm the direction before writing code.
2222
- **Chores**: typos, comment clarifications.
23-
Multiple typo or comment fixes can be combined into a single PR.
23+
Multiple typos or comment fixes can be combined into a single pull request.
2424

2525
What we'll generally **decline**:
2626

2727
- Stylistic refactors that don't improve performance, correctness, or
2828
testability. Code style is subjective and large diffs make `git blame` worse.
2929
We're happy to accept small, principled cleanups alongside other work.
3030
- Changes which result in a breaking change.
31-
- "Drive-by" PRs where the contributor isn't available to address review
31+
- "Drive-by" pull requests where the contributor isn't available to address review
3232
comments.
3333

3434
## Pull request guidelines
3535

36-
- **One concern per PR.** Smaller PRs get faster reviews.
36+
- **One concern per pull request.** Smaller pull requests get faster reviews.
3737
- **Tests are required** for bug fixes (regression test) and new features
3838
(coverage of the new path).
3939
- **CI must be green** before a PR is merged. If a CI failure looks unrelated
@@ -44,7 +44,7 @@ What we'll generally **decline**:
4444
make small fixups directly.
4545
- **Don't force-push** after a maintainer has started reviewing. Push new
4646
commits; we squash on merge.
47-
- **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.
47+
- **Pull request 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.
4848

4949
### Commit messages
5050

@@ -88,7 +88,7 @@ You may use AI assistants when contributing, subject to all the following:
8888
## Licensing
8989

9090
By submitting a contribution, you agree that it is licensed under the same
91-
licence as the repository you're contributing to. See each repo's `LICENSE`
91+
licence as the repository you're contributing to. See each repository's `LICENSE`
9292
file.
9393

9494
Thanks for contributing. If something in these guidelines is unclear or seems

0 commit comments

Comments
 (0)