You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,31 +9,31 @@ This project follows the core values of the [Contributor Covenant Code of Conduc
9
9
1.**Check first** that the bug isn't already filed — search both open and
10
10
closed issues. If you find a match, add a 👍 reaction or a comment with new
11
11
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.
13
13
14
14
## Proposing a change
15
15
16
16
The kinds of pull requests we welcome:
17
17
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
19
19
what is being fixed and how to verify it. A regression test is expected.
20
20
-**New features** that solve a use case shared by a meaningful portion of users.
21
21
**Please open an issue first** and wait for a maintainer to confirm the direction before writing code.
22
22
-**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.
24
24
25
25
What we'll generally **decline**:
26
26
27
27
- Stylistic refactors that don't improve performance, correctness, or
28
28
testability. Code style is subjective and large diffs make `git blame` worse.
29
29
We're happy to accept small, principled cleanups alongside other work.
30
30
- 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
32
32
comments.
33
33
34
34
## Pull request guidelines
35
35
36
-
-**One concern per PR.** Smaller PRs get faster reviews.
36
+
-**One concern per pull request.** Smaller pull requests get faster reviews.
37
37
-**Tests are required** for bug fixes (regression test) and new features
38
38
(coverage of the new path).
39
39
-**CI must be green** before a PR is merged. If a CI failure looks unrelated
@@ -44,7 +44,7 @@ What we'll generally **decline**:
44
44
make small fixups directly.
45
45
-**Don't force-push** after a maintainer has started reviewing. Push new
46
46
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.
48
48
49
49
### Commit messages
50
50
@@ -88,7 +88,7 @@ You may use AI assistants when contributing, subject to all the following:
88
88
## Licensing
89
89
90
90
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`
92
92
file.
93
93
94
94
Thanks for contributing. If something in these guidelines is unclear or seems
0 commit comments