LCORE-666: Updated pull request template and add section about AI tools usage into contributing guide#839
Conversation
WalkthroughThis pull request adds documentation guidelines for disclosing AI tool usage in pull requests and contribution processes. It introduces a new PR template section and expands CONTRIBUTING.md with AI assistant guidelines and copyright notice guidance. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks)CONTRIBUTING.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
CONTRIBUTING.md
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
129-129: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
135-135: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: build-pr
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
- GitHub Check: e2e_tests (ci)
- GitHub Check: e2e_tests (azure)
🔇 Additional comments (2)
.github/PULL_REQUEST_TEMPLATE.md (1)
24-29: Excellent addition to the PR template.The new "Tools used to create PR" section clearly prompts contributors to disclose AI tool usage with appropriate fields (Assisted-by and Generated by) and provides a simple "N/A if not used" fallback. The section is well-placed and well-worded.
CONTRIBUTING.md (1)
115-146: Excellent guidance on AI tool attribution and copyright considerations.The new "AI assistants" section provides clear, balanced guidance for contributors on marking AI-generated or AI-assisted content, aligning with the PR template changes. The subsection on copyright and licence notices appropriately addresses the legal/attribution implications without being overly prescriptive.
| * [AI assistants](#ai-assistants) | ||
| * [“Mark” code with substantial AI-generated portions.](#mark-code-with-substantial-ai-generated-portions) | ||
| * [Copyright and licence notices](#copyright-and-licence-notices) |
There was a problem hiding this comment.
Fix markdown list indentation in TOC.
Lines 14-15 have incorrect indentation for nested list items. According to markdownlint (MD007), nested list items should be indented by 2 spaces, not 4.
Apply this diff to fix the indentation:
* [AI assistants](#ai-assistants)
- * ["Mark" code with substantial AI-generated portions.](#mark-code-with-substantial-ai-generated-portions)
- * [Copyright and licence notices](#copyright-and-licence-notices)
+ * ["Mark" code with substantial AI-generated portions.](#mark-code-with-substantial-ai-generated-portions)
+ * [Copyright and licence notices](#copyright-and-licence-notices)🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🤖 Prompt for AI Agents
In CONTRIBUTING.md around lines 13 to 15 the nested TOC items under "AI
assistants" are indented with 4 spaces which violates markdownlint MD007; update
the indentation of the nested list items on lines 14-15 to 2 spaces (i.e., align
them as directly nested under the parent list item) so the TOC uses consistent
2-space indentation for nested list entries.
| ``` | ||
| Assisted-by: <name of code assistant> | ||
| ``` | ||
|
|
||
| In a source file comment, indicate the use of the code assistant. For example: | ||
|
|
||
| ``` | ||
| Generated by: <name of code assistant> | ||
| ``` |
There was a problem hiding this comment.
Specify language for fenced code blocks.
Lines 129-137 contain a fenced code block without a language specifier. Add the appropriate language identifier (likely text or similar, or consider whether git is more appropriate for commit message examples).
Apply this diff to add language specification:
-```
+```text
Assisted-by: <name of code assistant>
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
129-129: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
135-135: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In CONTRIBUTING.md around lines 129 to 137, the fenced code block showing the
"Assisted-by" commit trailer lacks a language specifier; update the fence to use
a suitable language tag (e.g., text or git) so the block becomes ```text (or
```git if you prefer) and close with ``` to ensure proper syntax highlighting
and consistency with other examples.
| In a source file comment, indicate the use of the code assistant. For example: | ||
|
|
||
| ``` | ||
| Generated by: <name of code assistant> | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Specify language for fenced code block in comment example.
Lines 135-137 contain a fenced code block without a language specifier. Add text or an appropriate language identifier.
Apply this diff to add language specification:
-```
+```text
Generated by: <name of code assistant>
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
135-135: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
CONTRIBUTING.md around lines 133 to 138: the example fenced code block lacks a
language specifier; update the block to use a language identifier (e.g., text)
by replacing the opening triple backticks with ```text so the snippet becomes a
fenced block with language specified.
1 participant
Description
LCORE-666: Updated pull request template and add section about AI tools usage into contributing guide
Type of change
Related Tickets & Documents
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.