Skip to content

Commit 7377040

Browse files
committed
doc: add PR template
1 parent a5cfd17 commit 7377040

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

Diff for: .github/pull_request_template.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Summary
2+
3+
<!-- Give a brief description of what your PR does. -->
4+
5+
This PR adds..
6+
7+
## Related Issues
8+
9+
<!-- Link issues that are related to this PR. You may link issues you think should be closed by this PR. -->
10+
11+
Related #
12+
13+
Closes #
14+
15+
## Changes
16+
17+
<!-- List the major changes made in this PR. -->
18+
19+
- List changes here
20+
21+
## Checklist
22+
23+
I confirm that I have:
24+
25+
- [ ] **Followed the
26+
[Conventional Commits](https://www.conventionalcommits.org/)
27+
specification** (e.g., `feat: add new feature`, `fix: correct bug`,
28+
`docs: update documentation`).
29+
- [ ] **My PR title also follows the conventional commits specification.**
30+
- [ ] **Updated relevant documentation,** if necessary.
31+
- [ ] **Thoroughly tested my changes.**
32+
- [ ] **Added tests** (if applicable) and verified existing tests pass with
33+
`make test`.
34+
- [ ] **Checked for breaking changes** and documented them, if any.

Diff for: docs/contributing.org

+6
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,9 @@ make test FILE=./tests/plenary/api/api_spec.lua
9696
:CUSTOM_ID: parser
9797
:END:
9898
Parsing is done via builtin treesitter parser and the [[https://github.com/milisims/tree-sitter-org][tree-sitter-org]] grammar.
99+
100+
**** Commits
101+
:PROPERTIES:
102+
:CUSTOM_ID: commits
103+
:END:
104+
Ensure that you follow the [[https://www.conventionalcommits.org/][Conventional Commits]] specification (e.g., =feat: add new feature=, =fix: correct bug=, =docs: update documentation=).

0 commit comments

Comments
 (0)