docs: add comprehensive CONTRIBUTING.md guide#430
Open
Devvekariya711 wants to merge 2 commits intokavishdevar:mainfrom
Open
docs: add comprehensive CONTRIBUTING.md guide#430Devvekariya711 wants to merge 2 commits intokavishdevar:mainfrom
Devvekariya711 wants to merge 2 commits intokavishdevar:mainfrom
Conversation
- Add structured contribution guidelines with table of contents - Include development setup for Android and Linux platforms - Document code style guidelines and commit conventions - Add PR submission process and checklists - Include bug reporting and feature request guidelines - Move translation guide to appendix for better organization - Addresses the missing contribution documentation
📝 WalkthroughWalkthroughAdds a new CONTRIBUTING.md outlining contributor policies and workflows, development setup and build/test steps for Android and Linux, branching and commit conventions, PR process, code style guidelines (Kotlin/C++), translation workflows, and related reference links (341 lines added). Changes
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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: 2
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 268-269: Update the misspelled link text "AAP Protocol
(Third-party)" target URL label from "AAP-Protocol-Defintion" to the correct
spelling "AAP-Protocol-Definition" and verify the linked URL is valid; modify
the markdown line containing the link text/URL so the display text and the
GitHub repository path use "Definition" instead of "Defintion" to prevent a 404.
- Around line 69-84: Update the Android toolchain notes: replace "Android Studio
Ladybug (2024.2.1+)" with "Android Studio Narwhal (2025.1.x)" and change the
minimum Android SDK requirement from "API 33 (min)" to "API 35 (min)" while
keeping target API (API 36) if desired; also add a brief Qt recommendation under
"Linux Development" specifying a tested Qt 6 version (e.g., "Qt 6.10.1") so
readers know which Qt 6 release to use, leaving CMake 3.22+ and OpenSSL/libpulse
headers unchanged.
🧹 Nitpick comments (3)
CONTRIBUTING.md (3)
215-223: Add language to fenced code block (MD040).Markdownlint flags this block; add a language (e.g.,
text) to avoid lint failures.✏️ Proposed fix
-``` +```text <type>(<scope>): <description> [optional body] [optional footer]</details> --- `235-239`: **Add language to fenced code block (MD040).** Same lint issue as above for the examples block. <details> <summary>✏️ Proposed fix</summary> ```diff -``` +```text feat(android): add German translation fix(linux): resolve system tray detection docs: update development setup guide</details> --- `198-199`: **Timestamp the hiatus note to reduce staleness.** This is time-sensitive. Consider adding “as of January 2026” so readers know when it was accurate. <details> <summary>✏️ Proposed tweak</summary> ```diff -3. **Wait for review** (Note: Maintainer on hiatus until May 2026) +3. **Wait for review** (Note: Maintainer on hiatus until May 2026, as of January 2026)
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 217-223: Update the fenced code block that shows the commit
message template by adding the language identifier "text" after the opening
backticks so markdownlint MD040 is satisfied; specifically modify the block that
starts with ``` and contains "<type>(<scope>): <description>" to begin with
```text and keep the inner commit template content unchanged.
- Around line 235-239: The fenced code block showing commit examples is missing
a language tag (triggers markdownlint MD040); update the triple-backtick block
that contains the three commit lines (`feat(android): add German translation`,
`fix(linux): resolve system tray detection`, `docs: update development setup
guide`) to include the `text` language specifier (i.e., change ``` to ```text)
so the block is fenced with a language.
Comment on lines
+217
to
+223
| ``` | ||
| <type>(<scope>): <description> | ||
|
|
||
| [optional body] | ||
|
|
||
| [optional footer] | ||
| ``` |
There was a problem hiding this comment.
Add language to fenced code block for commit format.
markdownlint (MD040) flags missing language. Use text to keep formatting consistent.
✅ Proposed fix
-```
+```text
<type>(<scope>): <description>
[optional body]
[optional footer]🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
217-217: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` around lines 217 - 223, Update the fenced code block that
shows the commit message template by adding the language identifier "text" after
the opening backticks so markdownlint MD040 is satisfied; specifically modify
the block that starts with ``` and contains "<type>(<scope>): <description>" to
begin with ```text and keep the inner commit template content unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.