Skip to content

Commit 4598797

Browse files
committed
docs(skills): Start adding code-review skills for Copilot
Add a few instructions how Copilot should review pull requests to reduce the amount of repetitive comments done by reviewers. Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.io>
1 parent b8f4b68 commit 4598797

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Commits in the Git history
2+
3+
As outlined in the [contributing guidelines], each commit in a pull request should adhere to the following rules:
4+
5+
* The title should follow the [Conventional Commits] specification with the [commitlint configuration].
6+
* The description part of the title should start with an uppercase character.
7+
* The title should not exceed 75 characters in length.
8+
* Body lines should not exceed 75 characters and must be hard-wrapped with line-end characters.
9+
* The body should provide a rationale for the change and not just repeat the code diff.
10+
* Symbols should be enclosed in backticks so they render nicely in a Markdown view.
11+
* The language should be American English without spelling- or grammar-mistakes.
12+
13+
## Tests written in Kotlin using the Kotest framework
14+
15+
* Prefer the syntax where Kotest specs get the body passed as a lambda constructor argument.
16+
* Infix matcher syntax should be preferred.
17+
* Specific matchers like `collection should haveSize(2)` should be preferred over general matchers like `collection.size shouldBe 2`.
18+
19+
[contributing guidelines]: https://github.com/oss-review-toolkit/.github/blob/main/CONTRIBUTING.md
20+
[Conventional Commits]: https://www.conventionalcommits.org/
21+
[commitlint configuration]: https://github.com/oss-review-toolkit/ort/blob/main/.commitlintrc.yml

0 commit comments

Comments
 (0)