chore(sync): synced file(s) with raul3k/repo-template#13
Conversation
WalkthroughThe PR adds a new contribution guidelines file and updates the bug report template. The bug report template is enhanced to include Windows 11 as a supported OS and standardizes the version field naming. A comprehensive CONTRIBUTING.md file is introduced with guidelines for code of conduct, bug reporting, feature requests, pull request procedures, and commit message conventions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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: 2
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Line 56: Update the CONTRIBUTING.md table entry for the `docs` category to
hyphenate the phrase by changing "Documentation only changes" to
"Documentation-only changes" so the row reads: `| `docs` |
Documentation-only changes |`; modify the table cell where
`docs` appears to apply this minor grammar fix.
- Around line 52-61: The Markdown table in CONTRIBUTING.md violates markdownlint
rule MD060 due to inconsistent pipe alignment; fix it by aligning the pipes for
the header row, the separator row (`| ---------- |
------------------------------------------------ |`) and all subsequent rows so
each column starts/ends in the same character position, ensuring the header,
separator and content rows share the same column widths and pipe positions;
update the existing rows for `Type`, `Description`, and each tag (`feat`, `fix`,
`docs`, `style`, `refactor`, `test`, `chore`) to match the aligned layout.
| | Type | Description | | ||
| | ---------- | ------------------------------------------------ | | ||
| | `feat` | A new feature | | ||
| | `fix` | A bug fix | | ||
| | `docs` | Documentation only changes | | ||
| | `style` | Code style changes (formatting, semicolons, etc.) | | ||
| | `refactor` | Code changes that neither fix bugs nor add features | | ||
| | `test` | Adding or updating tests | | ||
| | `chore` | Maintenance tasks, dependencies, configs | | ||
|
|
There was a problem hiding this comment.
Align table pipes to satisfy markdownlint (MD060).
If markdownlint is enforced, adjust column alignment to avoid lint failures.
🧹 Example alignment (one possible layout)
-| Type | Description |
-| ---------- | ------------------------------------------------ |
-| `feat` | A new feature |
-| `fix` | A bug fix |
-| `docs` | Documentation only changes |
-| `style` | Code style changes (formatting, semicolons, etc.) |
-| `refactor` | Code changes that neither fix bugs nor add features |
-| `test` | Adding or updating tests |
-| `chore` | Maintenance tasks, dependencies, configs |
+| Type | Description |
+| ---------- | --------------------------------------------------- |
+| `feat` | A new feature |
+| `fix` | A bug fix |
+| `docs` | Documentation-only changes |
+| `style` | Code style changes (formatting, semicolons, etc.) |
+| `refactor` | Code changes that neither fix bugs nor add features |
+| `test` | Adding or updating tests |
+| `chore` | Maintenance tasks, dependencies, configs |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Type | Description | | |
| | ---------- | ------------------------------------------------ | | |
| | `feat` | A new feature | | |
| | `fix` | A bug fix | | |
| | `docs` | Documentation only changes | | |
| | `style` | Code style changes (formatting, semicolons, etc.) | | |
| | `refactor` | Code changes that neither fix bugs nor add features | | |
| | `test` | Adding or updating tests | | |
| | `chore` | Maintenance tasks, dependencies, configs | | |
| | Type | Description | | |
| | ---------- | --------------------------------------------------- | | |
| | `feat` | A new feature | | |
| | `fix` | A bug fix | | |
| | `docs` | Documentation-only changes | | |
| | `style` | Code style changes (formatting, semicolons, etc.) | | |
| | `refactor` | Code changes that neither fix bugs nor add features | | |
| | `test` | Adding or updating tests | | |
| | `chore` | Maintenance tasks, dependencies, configs | |
🧰 Tools
🪛 LanguageTool
[grammar] ~56-~56: Use a hyphen to join words.
Context: ... | | docs | Documentation only changes | | `...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.20.0)
57-57: Table column style
Table pipe does not align with header for style "aligned"
(MD060, table-column-style)
58-58: Table column style
Table pipe does not align with header for style "aligned"
(MD060, table-column-style)
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` around lines 52 - 61, The Markdown table in CONTRIBUTING.md
violates markdownlint rule MD060 due to inconsistent pipe alignment; fix it by
aligning the pipes for the header row, the separator row (`| ---------- |
------------------------------------------------ |`) and all subsequent rows so
each column starts/ends in the same character position, ensuring the header,
separator and content rows share the same column widths and pipe positions;
update the existing rows for `Type`, `Description`, and each tag (`feat`, `fix`,
`docs`, `style`, `refactor`, `test`, `chore`) to match the aligned layout.
| | ---------- | ------------------------------------------------ | | ||
| | `feat` | A new feature | | ||
| | `fix` | A bug fix | | ||
| | `docs` | Documentation only changes | |
There was a problem hiding this comment.
Hyphenate “Documentation-only”.
Minor grammar fix to satisfy LanguageTool.
✏️ Proposed fix
-| `docs` | Documentation only changes |
+| `docs` | Documentation-only changes |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `docs` | Documentation only changes | | |
| | `docs` | Documentation-only changes | |
🧰 Tools
🪛 LanguageTool
[grammar] ~56-~56: Use a hyphen to join words.
Context: ... | | docs | Documentation only changes | | `...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` at line 56, Update the CONTRIBUTING.md table entry for the
`docs` category to hyphenate the phrase by changing "Documentation only changes"
to "Documentation-only changes" so the row reads: `| `docs` |
Documentation-only changes |`; modify the table cell where
`docs` appears to apply this minor grammar fix.
1 participant
synced local file(s) with raul3k/repo-template.
Changed files
.github/ISSUE_TEMPLATE/with remote directory.github/ISSUE_TEMPLATE/CONTRIBUTING.mdfrom remoteCONTRIBUTING.mdThis PR was created automatically by the repo-file-sync-action workflow run #21479506920
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.