Create CONTRIBUTING.md #136
Conversation
WalkthroughThe pull request introduces a comprehensive "Contributing" section in the Changes
Sequence DiagramsequenceDiagram
participant Contributor
participant GitHub
participant ProjectTeam
Contributor->>GitHub: Open Issue/Feature Request
GitHub->>ProjectTeam: Notify of New Submission
ProjectTeam->>ProjectTeam: Review and Label Issue
ProjectTeam->>Contributor: Request Additional Information (if needed)
Contributor-->>ProjectTeam: Provide Details
ProjectTeam->>ProjectTeam: Evaluate Submission
ProjectTeam->>GitHub: Update Issue Status
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
CONTRIBUTING.md (6)
2-2: Fix double punctuation markRemove the period after the exclamation mark.
-Thank you so much for your interest in contributing!. All types of contributions are encouraged and valued. +Thank you so much for your interest in contributing! All types of contributions are encouraged and valued.🧰 Tools
🪛 LanguageTool
[formatting] ~2-~2: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...o much for your interest in contributing!. All types of contributions are encourag...(DOUBLE_PUNCTUATION_PREMIUM)
19-19: Use inline link formatting for URLsConvert the bare URL to proper Markdown link syntax.
-* Open an Issue at https://github.com/canopas/group-track-android/issues +* Open an Issue at [our issues page](https://github.com/canopas/group-track-android/issues)🧰 Tools
🪛 Markdownlint (0.37.0)
19-19: null
Bare URL used(MD034, no-bare-urls)
36-36: Improve clarity and formatting
- Format the URL as a proper Markdown link
- Consider using "reproduction" instead of "repro" for clarity
-* Open an Issue at https://github.com/canopas/group-track-android/issues +* Open an Issue at [our issues page](https://github.com/canopas/group-track-android/issues) -* A team member will try to reproduce the issue with your provided steps. If there are no repro steps or no obvious way to reproduce the issue +* A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issueAlso applies to: 43-43
🧰 Tools
🪛 Markdownlint (0.37.0)
36-36: null
Bare URL used(MD034, no-bare-urls)
48-48: Fix heading indentationRemove the extra space before the heading.
- ## Request Support +## Request Support🧰 Tools
🪛 Markdownlint (0.37.0)
48-48: null
Headings must start at the beginning of the line(MD023, heading-start-left)
64-64: Improve language professionalism and link accuracy
- Replace informal language with more professional alternatives
- Add proper link to requirements section
-So you wanna contribute some code! +So you want to contribute some code! -Follow the [requirements](https://github.com/canopas/group-track-android?tab=readme-ov-file#requirements) +Follow the [project requirements](../README.md#requirements)Also applies to: 68-68
🧰 Tools
🪛 LanguageTool
[style] ~64-~64: The word ‘wanna’ is informal.
Context: ...already made. ## Project Setup So you wanna contribute some code! That's great! Thi...(WANNA)
1-71: Overall document structure feedbackThe document provides a good foundation for contribution guidelines, but needs some improvements:
- Add missing referenced sections:
- Label issues process
- Code contribution guidelines
- Consider adding sections for:
- Pull request process
- Code review expectations
- Coding standards
- Commit message guidelines
Would you like me to help draft any of these additional sections?
🧰 Tools
🪛 LanguageTool
[formatting] ~2-~2: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...o much for your interest in contributing!. All types of contributions are encourag...(DOUBLE_PUNCTUATION_PREMIUM)
[style] ~44-~44: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ntil they are reproduced. * If the team is able to reproduce the issue, it will be marked ...(BE_ABLE_TO)
[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...l be closed](#clean-up-issues-and-prs). If you want to come back to it, reply (onc...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~46-~46: When a number forms part of an adjectival compound, use a hyphen.
Context: ...d immediacy and severity, even past the 30 day deadline. ## Request Support If you ...(MISSING_HYPHEN)
[style] ~64-~64: The word ‘wanna’ is informal.
Context: ...already made. ## Project Setup So you wanna contribute some code! That's great! Thi...(WANNA)
[uncategorized] ~66-~66: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...one it before. If this seems like a lot or you aren't able to do all this setup, y...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~68-~68: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ov-file#requirements) to run the project and you should be ready to go!(COMMA_COMPOUND_SENTENCE)
[style] ~68-~68: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 4200 characters long)
Context: ...he project and you should be ready to go!(EN_EXCESSIVE_EXCLAMATION)
🪛 Markdownlint (0.37.0)
48-48: null
Headings must start at the beginning of the line(MD023, heading-start-left)
19-19: null
Bare URL used(MD034, no-bare-urls)
36-36: null
Bare URL used(MD034, no-bare-urls)
52-52: null
Bare URL used(MD034, no-bare-urls)
25-25: null
Link fragments should be valid(MD051, link-fragments)
27-27: null
Link fragments should be valid(MD051, link-fragments)
42-42: null
Link fragments should be valid(MD051, link-fragments)
45-45: null
Link fragments should be valid(MD051, link-fragments)
58-58: null
Link fragments should be valid(MD051, link-fragments)
60-60: null
Link fragments should be valid(MD051, link-fragments)
66-66: null
Link fragments should be valid(MD051, link-fragments)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[formatting] ~2-~2: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...o much for your interest in contributing!. All types of contributions are encourag...
(DOUBLE_PUNCTUATION_PREMIUM)
[style] ~44-~44: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ntil they are reproduced. * If the team is able to reproduce the issue, it will be marked ...
(BE_ABLE_TO)
[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...l be closed](#clean-up-issues-and-prs). If you want to come back to it, reply (onc...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~46-~46: When a number forms part of an adjectival compound, use a hyphen.
Context: ...d immediacy and severity, even past the 30 day deadline. ## Request Support If you ...
(MISSING_HYPHEN)
[style] ~64-~64: The word ‘wanna’ is informal.
Context: ...already made. ## Project Setup So you wanna contribute some code! That's great! Thi...
(WANNA)
[uncategorized] ~66-~66: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...one it before. If this seems like a lot or you aren't able to do all this setup, y...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~68-~68: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ov-file#requirements) to run the project and you should be ready to go!
(COMMA_COMPOUND_SENTENCE)
[style] ~68-~68: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 4200 characters long)
Context: ...he project and you should be ready to go!
(EN_EXCESSIVE_EXCLAMATION)
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
48-48: null
Headings must start at the beginning of the line
(MD023, heading-start-left)
19-19: null
Bare URL used
(MD034, no-bare-urls)
36-36: null
Bare URL used
(MD034, no-bare-urls)
52-52: null
Bare URL used
(MD034, no-bare-urls)
25-25: null
Link fragments should be valid
(MD051, link-fragments)
27-27: null
Link fragments should be valid
(MD051, link-fragments)
42-42: null
Link fragments should be valid
(MD051, link-fragments)
45-45: null
Link fragments should be valid
(MD051, link-fragments)
58-58: null
Link fragments should be valid
(MD051, link-fragments)
60-60: null
Link fragments should be valid
(MD051, link-fragments)
66-66: null
Link fragments should be valid
(MD051, link-fragments)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
11-13:
Update anchor links to match heading IDs
The quicklinks section contains references to non-existent anchor IDs. GitHub automatically generates heading IDs by converting to lowercase and replacing spaces with hyphens.
- * [Request a Feature](#request-a-feature)
- * [Report an Error or Bug](#report-an-error-or-bug)
- * [Request Support](#request-support)
+ * [Request a Feature](#request-a-feature)
+ * [Report an Error or Bug](#report-an-error-or-bug)
+ * [Request Support](#request-support)Likely invalid or redundant comment.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
CONTRIBUTING.md (7)
2-2: Fix double punctuationRemove the redundant punctuation mark.
-Thank you so much for your interest in contributing!. All types of contributions are encouraged and valued. +Thank you so much for your interest in contributing! All types of contributions are encouraged and valued.🧰 Tools
🪛 LanguageTool
[formatting] ~2-~2: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...o much for your interest in contributing!. All types of contributions are encourag...(DOUBLE_PUNCTUATION_PREMIUM)
28-28: Use markdown link syntaxConvert the bare URL to a proper markdown link for better formatting.
-* Open an Issue at https://github.com/canopas/group-track-android/issues +* Open an Issue at [GitHub Issues](https://github.com/canopas/group-track-android/issues)🧰 Tools
🪛 Markdownlint (0.37.0)
28-28: null
Bare URL used(MD034, no-bare-urls)
55-55: Add hyphen in compound adjectiveAdd a hyphen between "30" and "day" when used as a compound adjective.
-even past the 30 day deadline. +even past the 30-day deadline.🧰 Tools
🪛 LanguageTool
[uncategorized] ~55-~55: When a number forms part of an adjectival compound, use a hyphen.
Context: ...d immediacy and severity, even past the 30 day deadline. ## Request Support If you ...(MISSING_HYPHEN)
73-73: Use formal language in documentationReplace informal language with more professional alternatives.
-So you wanna contribute some code! +So you want to contribute some code!🧰 Tools
🪛 LanguageTool
[style] ~73-~73: The word ‘wanna’ is informal.
Context: ...already made. ## Project Setup So you wanna contribute some code! That's great! Thi...(WANNA)
127-140: Fix table formatting and add missing cellsThe table has inconsistent formatting and missing cells. Please:
- Remove trailing pipes
- Add missing cells in rows
- Ensure consistent column count
Example fix for one row:
-`critical` | Added to `bug` issues if the problem described makes the code completely unusable in a common situation. | +`critical` | Added to `bug` issues if the problem described makes the code completely unusable in a common situation. | High priority for maintainers🧰 Tools
🪛 LanguageTool
[style] ~132-~132: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...dded to issues or PRs that refer to the exact same issue as another one that's been previo...(EN_WORDINESS_PREMIUM_EXACT_SAME)
[style] ~135-~135: Consider using “who” when you are referring to a person instead of an object.
Context: ...bmitter should @mention the team member that applied the label once the PR is comple...(THAT_WHO)
[style] ~140-~140: This phrase is redundant. Consider using “outside”.
Context: ...h the project or are otherwise entirely outside of its scope/sphere of influence or mainta...(OUTSIDE_OF)
[uncategorized] ~140-~140: Possible missing comma found.
Context: ...entirely outside of its scope/sphere of influence or maintainer decide to pass on an othe...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~140-~140: Consider shortening this phrase to just “whether”, or rephrase the sentence to avoid “as to”.
Context: ...decision ultimately falls on committers as to whether to accept something or not. ## Clean U...(WHETHER)
🪛 Markdownlint (0.37.0)
130-130: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
133-133: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
136-136: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
137-137: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
139-139: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
130-130: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
133-133: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
136-136: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
137-137: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
139-139: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
159-168: Use consistent heading style and list formattingConvert the setext-style heading to ATX-style and use consistent list markers.
-Merge Pull Requests ----------------------------------------------------------- +## Merge Pull Requests - - The change is easier to understand as a series of focused commits. - - Contributor is using an e-mail address other than the primary GitHub address + * The change is easier to understand as a series of focused commits. + * Contributor is using an e-mail address other than the primary GitHub address🧰 Tools
🪛 LanguageTool
[uncategorized] ~162-~162: Possible missing comma found.
Context: ...your-commits) by default for individual contributions unless requested by the PR author. Do...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~167-~167: Possible missing article found.
Context: ...and as a series of focused commits. - Contributor is using an e-mail address other than t...(AI_HYDRA_LEO_MISSING_THE)
🪛 Markdownlint (0.37.0)
159-159: Expected: atx; Actual: setext
Heading style(MD003, heading-style)
166-166: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
167-167: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
1-168: Overall document structure improvements neededWhile the content is comprehensive, there are several structural improvements needed:
- Ensure all referenced sections exist and are properly linked
- Maintain consistent formatting throughout the document:
- Use ATX-style headings
- Use consistent list markers (asterisks)
- Format URLs as markdown links
- Fix table formatting
- Use formal language consistently
The document provides valuable guidelines but needs these refinements for better readability and maintainability.
🧰 Tools
🪛 LanguageTool
[formatting] ~2-~2: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...o much for your interest in contributing!. All types of contributions are encourag...(DOUBLE_PUNCTUATION_PREMIUM)
[style] ~53-~53: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ntil they are reproduced. * If the team is able to reproduce the issue, it will be marked ...(BE_ABLE_TO)
[style] ~54-~54: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...l be closed](#clean-up-issues-and-prs). If you want to come back to it, reply (onc...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~55-~55: When a number forms part of an adjectival compound, use a hyphen.
Context: ...d immediacy and severity, even past the 30 day deadline. ## Request Support If you ...(MISSING_HYPHEN)
[style] ~73-~73: The word ‘wanna’ is informal.
Context: ...already made. ## Project Setup So you wanna contribute some code! That's great! Thi...(WANNA)
[uncategorized] ~75-~75: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...one it before. If this seems like a lot or you aren't able to do all this setup, y...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~77-~77: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ov-file#requirements) to run the project and you should be ready to go! ## Contrib...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~88-~88: You might be missing the article “a” here.
Context: ...contribution works as expected. * Write clear, concise commit message(s). * Go to htt...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~103-~103: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... not uncommon for most of the issues on open source projects to be support-related question...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~106-~106: Consider a shorter alternative to avoid wordiness.
Context: ...ention a maintainer so they can do it. In order to help other folks out with their questio...(IN_ORDER_TO_PREMIUM)
[style] ~125-~125: ‘each and every’ might be wordy. Consider a shorter alternative.
Context: ...next one: don't feel obligated to label each and every issue yourself! Label | Apply When | N...(EN_WORDINESS_PREMIUM_EACH_AND_EVERY)
[style] ~132-~132: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...dded to issues or PRs that refer to the exact same issue as another one that's been previo...(EN_WORDINESS_PREMIUM_EXACT_SAME)
[style] ~135-~135: Consider using “who” when you are referring to a person instead of an object.
Context: ...bmitter should @mention the team member that applied the label once the PR is comple...(THAT_WHO)
[style] ~140-~140: This phrase is redundant. Consider using “outside”.
Context: ...h the project or are otherwise entirely outside of its scope/sphere of influence or mainta...(OUTSIDE_OF)
[uncategorized] ~140-~140: Possible missing comma found.
Context: ...entirely outside of its scope/sphere of influence or maintainer decide to pass on an othe...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~140-~140: Consider shortening this phrase to just “whether”, or rephrase the sentence to avoid “as to”.
Context: ...decision ultimately falls on committers as to whether to accept something or not. ## Clean U...(WHETHER)
[style] ~144-~144: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...after a while. Maybe they're abandoned. Maybe the team will just plain not have time ...(REP_MAYBE)
[style] ~151-~151: Consider removing “of” to be more concise
Context: ... oldest to newest*, and close them if all of the following are true: * not opened by...(ALL_OF_THE)
[uncategorized] ~162-~162: Possible missing comma found.
Context: ...your-commits) by default for individual contributions unless requested by the PR author. Do...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~167-~167: Possible missing article found.
Context: ...and as a series of focused commits. - Contributor is using an e-mail address other than t...(AI_HYDRA_LEO_MISSING_THE)
🪛 Markdownlint (0.37.0)
159-159: Expected: atx; Actual: setext
Heading style(MD003, heading-style)
166-166: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
167-167: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
57-57: null
Headings must start at the beginning of the line(MD023, heading-start-left)
28-28: null
Bare URL used(MD034, no-bare-urls)
45-45: null
Bare URL used(MD034, no-bare-urls)
61-61: null
Bare URL used(MD034, no-bare-urls)
89-89: null
Bare URL used(MD034, no-bare-urls)
130-130: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
133-133: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
136-136: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
137-137: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
139-139: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style(MD055, table-pipe-style)
130-130: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
133-133: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
136-136: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
137-137: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
139-139: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[formatting] ~2-~2: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...o much for your interest in contributing!. All types of contributions are encourag...
(DOUBLE_PUNCTUATION_PREMIUM)
[style] ~53-~53: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ntil they are reproduced. * If the team is able to reproduce the issue, it will be marked ...
(BE_ABLE_TO)
[style] ~54-~54: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...l be closed](#clean-up-issues-and-prs). If you want to come back to it, reply (onc...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~55-~55: When a number forms part of an adjectival compound, use a hyphen.
Context: ...d immediacy and severity, even past the 30 day deadline. ## Request Support If you ...
(MISSING_HYPHEN)
[style] ~73-~73: The word ‘wanna’ is informal.
Context: ...already made. ## Project Setup So you wanna contribute some code! That's great! Thi...
(WANNA)
[uncategorized] ~75-~75: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...one it before. If this seems like a lot or you aren't able to do all this setup, y...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~77-~77: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ov-file#requirements) to run the project and you should be ready to go! ## Contrib...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~88-~88: You might be missing the article “a” here.
Context: ...contribution works as expected. * Write clear, concise commit message(s). * Go to htt...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~103-~103: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... not uncommon for most of the issues on open source projects to be support-related question...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~106-~106: Consider a shorter alternative to avoid wordiness.
Context: ...ention a maintainer so they can do it. In order to help other folks out with their questio...
(IN_ORDER_TO_PREMIUM)
[style] ~125-~125: ‘each and every’ might be wordy. Consider a shorter alternative.
Context: ...next one: don't feel obligated to label each and every issue yourself! Label | Apply When | N...
(EN_WORDINESS_PREMIUM_EACH_AND_EVERY)
[style] ~132-~132: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...dded to issues or PRs that refer to the exact same issue as another one that's been previo...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[style] ~135-~135: Consider using “who” when you are referring to a person instead of an object.
Context: ...bmitter should @mention the team member that applied the label once the PR is comple...
(THAT_WHO)
[style] ~140-~140: This phrase is redundant. Consider using “outside”.
Context: ...h the project or are otherwise entirely outside of its scope/sphere of influence or mainta...
(OUTSIDE_OF)
[uncategorized] ~140-~140: Possible missing comma found.
Context: ...entirely outside of its scope/sphere of influence or maintainer decide to pass on an othe...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~140-~140: Consider shortening this phrase to just “whether”, or rephrase the sentence to avoid “as to”.
Context: ...decision ultimately falls on committers as to whether to accept something or not. ## Clean U...
(WHETHER)
[style] ~144-~144: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...after a while. Maybe they're abandoned. Maybe the team will just plain not have time ...
(REP_MAYBE)
[style] ~151-~151: Consider removing “of” to be more concise
Context: ... oldest to newest*, and close them if all of the following are true: * not opened by...
(ALL_OF_THE)
[uncategorized] ~162-~162: Possible missing comma found.
Context: ...your-commits) by default for individual contributions unless requested by the PR author. Do...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~167-~167: Possible missing article found.
Context: ...and as a series of focused commits. - Contributor is using an e-mail address other than t...
(AI_HYDRA_LEO_MISSING_THE)
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
159-159: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
166-166: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
167-167: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
57-57: null
Headings must start at the beginning of the line
(MD023, heading-start-left)
28-28: null
Bare URL used
(MD034, no-bare-urls)
45-45: null
Bare URL used
(MD034, no-bare-urls)
61-61: null
Bare URL used
(MD034, no-bare-urls)
89-89: null
Bare URL used
(MD034, no-bare-urls)
130-130: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
133-133: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
136-136: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
137-137: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
139-139: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
130-130: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
133-133: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
136-136: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
137-137: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
139-139: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (3)
CONTRIBUTING.md (3)
73-73: Use more professional languageConsider using more formal language in the documentation.
-So you wanna contribute some code? That's great! +Interested in contributing code? That's great!🧰 Tools
🪛 LanguageTool
[style] ~73-~73: The word ‘wanna’ is informal.
Context: ...already made. ## Project Setup So you wanna contribute some code? That's great! Thi...(WANNA)
103-103: Use more professional languageConsider using more formal language in the documentation.
-Helping out other users with their questions is an awesome way of contributing to any community. +Helping other users with their questions is an excellent way of contributing to any community.🧰 Tools
🪛 LanguageTool
[style] ~103-~103: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...out other users with their questions is an awesome way of contributing to any community. I...(AWESOME)
159-161: Use consistent heading styleUse ATX-style headings (with #) throughout the document for consistency.
-Merge Pull Requests ----------------------------------------------------------- +## Merge Pull Requests🧰 Tools
🪛 Markdownlint (0.37.0)
159-159: Expected: atx; Actual: setext
Heading style(MD003, heading-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~54-~54: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...l be closed](#clean-up-issues-and-prs). If you want to come back to it, reply (onc...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~73-~73: The word ‘wanna’ is informal.
Context: ...already made. ## Project Setup So you wanna contribute some code? That's great! Thi...
(WANNA)
[uncategorized] ~75-~75: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...one it before. If this seems like a lot or you aren't able to do all this setup, y...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~77-~77: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ov-file#requirements) to run the project and you should be ready to go! ## Contrib...
(COMMA_COMPOUND_SENTENCE)
[style] ~103-~103: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...out other users with their questions is an awesome way of contributing to any community. I...
(AWESOME)
[style] ~140-~140: This phrase is redundant. Consider using “outside”.
Context: ...h the project or are otherwise entirely outside of its scope/sphere of influence or the ma...
(OUTSIDE_OF)
[style] ~140-~140: Consider shortening this phrase to just “whether”, or rephrase the sentence to avoid “as to”.
Context: ...decision ultimately falls on committers as to whether to accept something or not. ## Clean U...
(WHETHER)
[style] ~144-~144: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...after a while. Maybe they're abandoned. Maybe the team will just not have time to add...
(REP_MAYBE)
[style] ~151-~151: Consider removing “of” to be more concise
Context: ... oldest to newest*, and close them if all of the following are true: * not opened by...
(ALL_OF_THE)
[uncategorized] ~167-~167: Possible missing article found.
Context: ...and as a series of focused commits. - Contributor is using an e-mail address other than t...
(AI_HYDRA_LEO_MISSING_THE)
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
159-159: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
166-166: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
167-167: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
57-57: null
Headings must start at the beginning of the line
(MD023, heading-start-left)
28-28: null
Bare URL used
(MD034, no-bare-urls)
45-45: null
Bare URL used
(MD034, no-bare-urls)
61-61: null
Bare URL used
(MD034, no-bare-urls)
89-89: null
Bare URL used
(MD034, no-bare-urls)
130-130: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
133-133: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
136-136: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
137-137: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
139-139: Expected: no_leading_or_trailing; Actual: trailing_only; Unexpected trailing pipe
Table pipe style
(MD055, table-pipe-style)
130-130: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
133-133: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
136-136: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
137-137: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
139-139: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
10-21: Fix broken section links in Quick Links
The following sections are referenced but don't exist in the document with matching heading IDs:
#label-issues#contribute-code
Please ensure all section links are properly connected to their corresponding headings.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
CONTRIBUTING.md (4)
6-6: Enhance link accessibilityConsider making the link text more descriptive for better accessibility.
-Similarly, if you support a particular feature request, please let us know by commenting on the issue or [subscribing](https://help.github.com/articles/subscribing-to-conversations/) to the issue. +Similarly, if you support a particular feature request, please let us know by commenting on the issue or [subscribing to the discussion](https://help.github.com/articles/subscribing-to-conversations/).
8-8: Enhance bug report guidelinesConsider adding more specific examples of what information to include in bug reports.
-If you are reporting a bug, please help speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project (or gist) that reproduces the problem. +If you are reporting a bug, please help speed up problem diagnosis by providing as much information as possible: +- Steps to reproduce the issue +- Expected behavior vs actual behavior +- Android version and device information +- Relevant logs or error messages +- Ideally, a small sample project (or gist) that reproduces the problem
31-32: Fix license section formattingThe license section has formatting issues.
- ## License - By contributing to GroupTrack, you agree that your contributions will be licensed under its Apache License, Version 2.0. See LICENSE file for details. +## License +By contributing to GroupTrack, you agree that your contributions will be licensed under its Apache License, Version 2.0. See [LICENSE](LICENSE) file for details.🧰 Tools
🪛 Markdownlint (0.37.0)
31-31: null
Headings must start at the beginning of the line(MD023, heading-start-left)
1-32: Consider adding a table of contentsFor better navigation, consider adding a table of contents at the beginning of the document. This would be especially helpful as the guidelines grow.
+# Contributing + +## Table of Contents +- [Filing Issues](#filing-issues) +- [Contributing Code](#contributing-code) +- [Labels](#labels) +- [License](#license) + # Contributing🧰 Tools
🪛 LanguageTool
[duplication] ~17-~17: Possible typo: you repeated a word
Context: ...s 4. Make sure your code lints. ## Labels Labels on issues are managed by contributors, ...(ENGLISH_WORD_REPEAT_RULE)
[style] ~24-~24: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...producible**: has enough information to very easily reproduce, mostly in the form of a smal...(EN_WEAK_ADJECTIVE)
[typographical] ~25-~25: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... code to be able to reproduce and debug locally, otherwise there's not much we can do * **duplica...(THUS_SENTENCE)
🪛 Markdownlint (0.37.0)
20-20: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
23-23: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
24-24: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
25-25: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
26-26: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
27-27: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
28-28: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
29-29: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
31-31: null
Headings must start at the beginning of the line(MD023, heading-start-left)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[duplication] ~17-~17: Possible typo: you repeated a word
Context: ...s 4. Make sure your code lints. ## Labels Labels on issues are managed by contributors, ...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~24-~24: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...producible**: has enough information to very easily reproduce, mostly in the form of a smal...
(EN_WEAK_ADJECTIVE)
[typographical] ~25-~25: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... code to be able to reproduce and debug locally, otherwise there's not much we can do * **duplica...
(THUS_SENTENCE)
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
20-20: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
21-21: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
22-22: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
23-23: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
24-24: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
25-25: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
26-26: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
27-27: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
28-28: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
29-29: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
31-31: null
Headings must start at the beginning of the line
(MD023, heading-start-left)
Changelog
Summary by CodeRabbit