Skip to content

Commit 899a075

Browse files
committed
📝(PR template) add AI checklist
so that we can keep welcoming external contributions Signed-off-by: virgile-deville <virgile.deville@beta.gouv.fr>
1 parent 5ecf3fe commit 899a075

File tree

2 files changed

+29
-14
lines changed

2 files changed

+29
-14
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,37 @@
11
## Purpose
22

3-
Describe the purpose of this pull request.
4-
3+
Describe the purpose of this pull request.
54

65
## Proposal
76

8-
- [ ] item 1...
9-
- [ ] item 2...
7+
* [ ] item 1...
8+
* [ ] item 2...
109

1110
## External contributions
1211

13-
Thank you for your contribution! 🎉
12+
Thank you for your contribution! 🎉
1413

1514
Please ensure the following items are checked before submitting your pull request:
16-
- [ ] I have read and followed the [contributing guidelines](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md)
17-
- [ ] I have read and agreed to the [Code of Conduct](https://github.com/suitenumerique/docs/blob/main/CODE_OF_CONDUCT.md)
18-
- [ ] I have signed off my commits with `git commit --signoff` (DCO compliance)
19-
- [ ] I have signed my commits with my SSH or GPG key (`git commit -S`)
20-
- [ ] My commit messages follow the required format: `<gitmoji>(type) title description`
21-
- [ ] I have added a changelog entry under `## [Unreleased]` section (if noticeable change)
22-
- [ ] I have added corresponding tests for new features or bug fixes (if applicable)
15+
16+
### General requirements
17+
18+
* [ ] I have read and followed the [contributing guidelines](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md)
19+
* [ ] I have read and agreed to the [Code of Conduct](https://github.com/suitenumerique/docs/blob/main/CODE_OF_CONDUCT.md)
20+
*Skip if you're fixing an issue or adding documentation*
21+
* [ ] Before submitting a PR for a new feature I made sure to contact the product manager
22+
23+
### Test requirements
24+
25+
* [ ] I have added corresponding tests for new features or bug fixes (if applicable)
26+
* [ ] I made sure that all existing tests are passing
27+
* [ ] I have signed off my commits with `git commit --signoff` (DCO compliance)
28+
* [ ] I have signed my commits with my SSH or GPG key (`git commit -S`)
29+
* [ ] My commit messages follow the required format: `<gitmoji>(type) title description`
30+
* [ ] I have added a changelog entry under `## [Unreleased]` section (if noticeable change)
31+
32+
### AI requirements
33+
34+
*Skip If you didn't use AI for your contribution*
35+
* [ ] I used AI assistance to produce part or all of this contribution
36+
* [ ] I have read, reviewed, understood and can explain the code I am submitting
37+
* [ ] I can jump in a call or a chat to explain my work to a maintainer

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ We use GitHub Projects to:
7373

7474
### Before you get started
7575

76-
* Run Docs locally, find detailed instructions in the [README.md](http://README.md)
76+
* Run Docs locally, find detailed instructions in the [README.md](README.md)
7777
* Check out the LaSuite [dev handbook](https://suitenumerique.gitbook.io/handbook) to learn our best practices
7878
* Join our [Matrix community channel](https://matrix.to/#/#docs-official:matrix.org)
7979
* Reach out to the product manager before working on feature
@@ -109,7 +109,7 @@ All commit messages must follow this format:
109109

110110
* **title**: A short, descriptive title for the change (*) **(less than 80 characters)**
111111

112-
* **blank line after the commit title
112+
* **blank line after the commit title**
113113

114114
* **description**: Include additional details on why you made the changes (**).
115115

0 commit comments

Comments
 (0)