Skip to content

Add ai policy contributing.md#2167

Merged
lunika merged 2 commits into
mainfrom
add-ai-policy-contributing-md
Apr 10, 2026
Merged

Add ai policy contributing.md#2167
lunika merged 2 commits into
mainfrom
add-ai-policy-contributing-md

Conversation

@virgile-dev
Copy link
Copy Markdown
Collaborator

Purpose

Revamped the contributing.md and added and AI policy so we can welcome contribution more easily.

Proposal

  • revamped contributing.md
  • revamped PR template

External contributions

Thank you for your contribution! 🎉

Please ensure the following items are checked before submitting your pull request:

  • I have read and followed the contributing guidelines
  • I have read and agreed to the Code of Conduct
  • I have signed off my commits with git commit --signoff (DCO compliance)
  • [ x I have signed my commits with my SSH or GPG key (git commit -S)
  • My commit messages follow the required format: <gitmoji>(type) title description
  • I have added a changelog entry under ## [Unreleased] section (if noticeable change)
  • I have added corresponding tests for new features or bug fixes (if applicable)

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 3, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 0cda58bd-aa8b-4a51-b15a-4d6a81e0774c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-ai-policy-contributing-md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@virgile-dev virgile-dev changed the title Add ai policy contributing md Add ai policy contributing.md Apr 3, 2026
@virgile-dev virgile-dev requested review from AntoLC and lunika April 3, 2026 08:36
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (2)
.github/PULL_REQUEST_TEMPLATE.md (1)

34-34: Minor wording consistency tweak: use sentence case in skip note.

For consistency with Line 20, consider *Skip if you didn't use AI for your contribution*.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/PULL_REQUEST_TEMPLATE.md at line 34, Update the template note "*Skip
If you didn't use AI for your contribution*" to sentence case so it reads "*Skip
if you didn't use AI for your contribution*" to match the style used elsewhere
(see the similar line at Line 20); modify the literal string in the file to
replace "If" with "if".
CONTRIBUTING.md (1)

38-38: Use descriptive link text to improve readability/accessibility.

Both links use vague text (here, here) and trigger markdownlint MD059.

♻️ Proposed patch
-We have dedicated labels for design work, the way we use them is described [here](https://docs.numerique.gouv.fr/docs/2d5cf334-1d0b-402f-a8bd-3f12b4cba0ce/).
+We have dedicated labels for design work, described in the [design labels guide](https://docs.numerique.gouv.fr/docs/2d5cf334-1d0b-402f-a8bd-3f12b4cba0ce/).

-* <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list [here](https://gitmoji.dev/).
+* <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the [gitmoji reference](https://gitmoji.dev/).

Also applies to: 106-106

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` at line 38, Replace the vague link text "here" in the
sentence "We have dedicated labels for design work, the way we use them is
described [here](...)." with a descriptive label such as "design label usage
guide" (or similar) so link text is meaningful and fixes markdownlint MD059;
update both occurrences (lines referenced by the snippet containing "We have
dedicated labels for design work, the way we use them is described
[here](https://docs.numerique.gouv.fr/docs/2d5cf334-1d0b-402f-a8bd-3f12b4cba0ce/)"
and the other occurrence noted at 106-106) to use descriptive link text.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 28: CONTRIBUTING.md contains typos that fail codespell (e.g.,
"documention" should be "documentation"); open CONTRIBUTING.md, fix the
misspellings reported by codespell (replace "documention"→"documentation" and
correct the other occurrences referenced at lines 86, 98, 169), run codespell
locally to verify no remaining issues, and commit the corrected file so the CI
no longer fails.
- Line 112: Replace the malformed checklist bullet "* **blank line after the
commit title" in the commit-message instructions with a valid markdown list
item; update the exact text string to a proper checklist or bullet such as "- [
] blank line after the commit title" or "* blank line after the commit title" so
it renders correctly in CONTRIBUTING.md.
- Line 76: Replace the invalid absolute URL "[README.md](http://README.md)" in
CONTRIBUTING.md with a repository-relative link by changing that link target to
"./README.md" (or "README.md") so contributors are directed correctly; locate
the markdown line containing the link text "[README.md](http://README.md)" and
update the link target accordingly.

---

Nitpick comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 34: Update the template note "*Skip If you didn't use AI for your
contribution*" to sentence case so it reads "*Skip if you didn't use AI for your
contribution*" to match the style used elsewhere (see the similar line at Line
20); modify the literal string in the file to replace "If" with "if".

In `@CONTRIBUTING.md`:
- Line 38: Replace the vague link text "here" in the sentence "We have dedicated
labels for design work, the way we use them is described [here](...)." with a
descriptive label such as "design label usage guide" (or similar) so link text
is meaningful and fixes markdownlint MD059; update both occurrences (lines
referenced by the snippet containing "We have dedicated labels for design work,
the way we use them is described
[here](https://docs.numerique.gouv.fr/docs/2d5cf334-1d0b-402f-a8bd-3f12b4cba0ce/)"
and the other occurrence noted at 106-106) to use descriptive link text.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 84a41144-bef6-4e25-b2e0-d8e09979d1bc

📥 Commits

Reviewing files that changed from the base of the PR and between 4b4319d and fe5d84a.

📒 Files selected for processing (2)
  • .github/PULL_REQUEST_TEMPLATE.md
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@suitenumerique suitenumerique deleted a comment from coderabbitai Bot Apr 3, 2026
@virgile-dev virgile-dev force-pushed the add-ai-policy-contributing-md branch from fe5d84a to 899a075 Compare April 3, 2026 14:10
@virgile-dev
Copy link
Copy Markdown
Collaborator Author

@AntoLC @lunika this is ready

Copy link
Copy Markdown
Collaborator

@AntoLC AntoLC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You still have typo:

./CONTRIBUTING.md:28: documention ==> documentation
./CONTRIBUTING.md:86: formating ==> formatting
./CONTRIBUTING.md:98: adressed ==> addressed
./CONTRIBUTING.md:169: responsability ==> responsibility

The italic part should be under I guess, no?
Image

@virgile-dev virgile-dev force-pushed the add-ai-policy-contributing-md branch 2 times, most recently from a3284a2 to ef345a8 Compare April 8, 2026 14:15
@AntoLC AntoLC added the documentation Improvements or additions to documentation label Apr 9, 2026
@virgile-dev virgile-dev force-pushed the add-ai-policy-contributing-md branch from ef345a8 to 9cf24e6 Compare April 9, 2026 18:20
@virgile-dev virgile-dev requested a review from AntoLC April 9, 2026 18:21
Copy link
Copy Markdown
Collaborator

@AntoLC AntoLC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You still have a typo, this job flags that:

Image

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Comment on lines +24 to +31
### Test requirements

* [ ] I have added corresponding tests for new features or bug fixes (if applicable)
* [ ] I made sure that all existing tests are passing
* [ ] I have signed off my commits with `git commit --signoff` (DCO compliance)
* [ ] I have signed my commits with my SSH or GPG key (`git commit -S`)
* [ ] My commit messages follow the required format: `<gitmoji>(type) title description`
* [ ] I have added a changelog entry under `## [Unreleased]` section (if noticeable change)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All this section is not about test, only the 2 first lines.

Copy link
Copy Markdown
Collaborator Author

@virgile-dev virgile-dev Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks will update ! sorry for the back and forth

@virgile-dev virgile-dev force-pushed the add-ai-policy-contributing-md branch from 9cf24e6 to 08b5545 Compare April 10, 2026 09:12
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@virgile-dev virgile-dev requested review from AntoLC and lunika April 10, 2026 09:35
@virgile-dev virgile-dev force-pushed the add-ai-policy-contributing-md branch 2 times, most recently from aee35f7 to 8791499 Compare April 10, 2026 11:00
so that we can keep  welcoming external contribution

Signed-off-by: virgile-deville <virgile.deville@beta.gouv.fr>
so that we can keep  welcoming external contributions

Signed-off-by: virgile-deville <virgile.deville@beta.gouv.fr>
@lunika lunika force-pushed the add-ai-policy-contributing-md branch from 8791499 to d0bf24f Compare April 10, 2026 12:32
@lunika lunika merged commit d0bf24f into main Apr 10, 2026
28 of 29 checks passed
@lunika lunika deleted the add-ai-policy-contributing-md branch April 10, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants