Conversation
so that we can keep welcoming external contribution Signed-off-by: virgile-deville <virgile.deville@beta.gouv.fr>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
.github/PULL_REQUEST_TEMPLATE.mdCONTRIBUTING.md
so that we can keep welcoming external contributions Signed-off-by: virgile-deville <virgile.deville@beta.gouv.fr>
fe5d84a to
899a075
Compare
Purpose
Revamped the contributing.md and added and AI policy so we can welcome contribution more easily.
Proposal
External contributions
Thank you for your contribution! 🎉
Please ensure the following items are checked before submitting your pull request:
git commit --signoff(DCO compliance)git commit -S)<gitmoji>(type) title description## [Unreleased]section (if noticeable change)