Skip to content

LCORE-666: Updated pull request template and add section about AI tools usage into contributing guide #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisnik merged 2 commits into from
Nov 25, 2025
Merged

LCORE-666: Updated pull request template and add section about AI tools usage into contributing guide #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23b3e3c
Updated pull request template
tisnik Nov 25, 2025
9ef5478
Info how to use AI tools added into contributing guide
tisnik Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@
- [ ] End to end tests improvement


## Tools used to create PR

Identify any AI code assistants used in this PR (for transparency and review context)

- Assisted-by: (e.g., Claude, CodeRabbit, Ollama, etc., N/A if not used)
- Generated by: (e.g., tool name and version; N/A if not used)

## Related Tickets & Documents

- Related Issue #
Expand Down
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
* [PR description](#pr-description)
* [Definition of Done](#definition-of-done)
* [A deliverable is to be considered “done” when](#a-deliverable-is-to-be-considered-done-when)
* [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)
Comment on lines +13 to +15
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Nov 25, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

* [Automation](#automation)
* [Pre-commit hook settings](#pre-commit-hook-settings)
* [Code coverage measurement](#code-coverage-measurement)
Expand Down Expand Up @@ -109,6 +112,38 @@ Happy hacking!
* Code changes reviewed by at least one peer
* Code changes acked by at least one project owner

## AI assistants

### “Mark” code with substantial AI-generated portions.

Nontrivial and substantial AI-generated or AI-assisted content should be
“marked” in appropriate cases. In deciding how to approach this, consider
adopting one or more of the following recommendations. (This assumes you have
not concluded that a suggestion is a match to some existing third-party code.)

In a commit message, or in a pull request/merge request description field,
identify the code assistant that you used, perhaps elaborating on how it was
used. You may wish to use a trailer like “Assisted-by:” or “Generated-by:”. For
example:

```
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>
```
Comment on lines +129 to +137
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Nov 25, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.


Comment on lines +133 to +138
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Nov 25, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

### Copyright and licence notices

If the contents of an entire file or files in PR were substantially generated
by a code assistant with little to no creative input or modification by you
(which should typically not be the case), copyright protection may be limited,
but it is particularly appropriate to mark the contents of the file as
recommended above.

## Automation

### Pre-commit hook settings
Expand Down
Loading