Docs: Add contribution guidelines and issue templates#6
Conversation
This commit introduces several files to establish and streamline the contribution process for the TriggerX project. Key changes: - **`.github/ISSUE_TEMPLATE/bug_report.md`**: New template for reporting bugs, guiding users to provide necessary details like steps to reproduce, expected behavior, device information, and TriggerX versions. - **`.github/ISSUE_TEMPLATE/feature_request.md`**: New template for suggesting features, asking for problem description, desired solution, alternatives considered, and additional context. - **`.github/PULL_REQUEST_TEMPLATE.md`**: New template for pull requests, including sections for description, type of change, testing details, and screenshots. - **`.github/CODEOWNERS`**: New file specifying default reviewers (`@cavin-macwan @meticha-admin`) for pull requests. - **`CODE_OF_CONDUCT.md`**: New file establishing a Code of Conduct for contributors, adapted from the Contributor Covenant. - **`CONTRIBUTING.md`**: New file providing detailed guidelines for contributors, including how to report issues, request features, set up the project, coding guidelines, and the process for submitting pull requests. These additions aim to make it easier for developers to contribute to TriggerX by providing clear instructions, templates, and standards for community interaction.
WalkthroughSeveral new project governance and contribution files have been added, including templates for issues and pull requests, a code of conduct, contribution guidelines, and a code owners file. These additions establish standardized processes for reporting bugs, requesting features, submitting pull requests, and maintaining community standards and project ownership. Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (11)
.github/ISSUE_TEMPLATE/feature_request.md (1)
4-6: Use YAML lists for multiple labels. Convert the comma-separatedlabelsfield into a proper YAML list and remove the extraneous blank line before the closing---. For example:title: "[FEAT] " - labels: enhancement, needs discussion + labels: + - enhancement + - needs discussion assignees: ''.github/ISSUE_TEMPLATE/bug_report.md (1)
27-30: Fix list indentation in the Device section.
Remove the extra leading space before each dash so that these items render as top-level list entries:- - Device: [e.g. Pixel 6] - - OS: [e.g. Android 13] - - TriggerX Library Version [e.g. 1.0.0] - - TriggerX Example App Version (if applicable) [e.g. 1.1] + - Device: [e.g. Pixel 6] + - OS: [e.g. Android 13] + - TriggerX Library Version [e.g. 1.0.0] + - TriggerX Example App Version (if applicable) [e.g. 1.1]🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
27-27: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
.github/PULL_REQUEST_TEMPLATE.md (1)
37-39: Use consistent list markers.
Switch the asterisks to dashes to match the rest of the template:- * Android Version(s): - * Device(s)/Emulator(s): - * TriggerXExample app variant: + - Android Version(s): + - Device(s)/Emulator(s): + - TriggerXExample app variant:🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
37-37: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
38-38: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
39-39: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
CODE_OF_CONDUCT.md (3)
31-31: Consider stronger terminology instead of "Trolling".
For consistency with the rest of the document, you might replace “Trolling” with “Harassing”:-* Trolling, insulting or derogatory comments, and personal or political attacks +* Harassing, insulting or derogatory comments, and personal or political attacks
66-66: Simplify wording for clarity.
Replace “with regard to” with the more concise “regarding”:- The project team is obligated to maintain confidentiality with regard to the reporter of an incident. + The project team is obligated to maintain confidentiality regarding the reporter of an incident.🧰 Tools
🪛 LanguageTool
[style] ~66-~66: ‘with regard to’ might be wordy. Consider a shorter alternative.
Context: ...s obligated to maintain confidentiality with regard to the reporter of an incident. Further de...(EN_WORDINESS_PREMIUM_WITH_REGARD_TO)
71-71: Add missing comma for readability.
Insert a comma after “good faith” to improve flow:- Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + Project maintainers who do not follow or enforce the Code of Conduct in good faith, may face temporary or permanent repercussions as determined by other members of the project's leadership.🧰 Tools
🪛 LanguageTool
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...d faith may face temporary or permanent repercussions as determined by other members of the p...(AI_HYDRA_LEO_MISSING_COMMA)
CONTRIBUTING.md (5)
23-23: Generalize the clone URL.Hardcoding
https://github.com/meticha/triggerx.gitmay mislead contributors. Instead, instruct to clone their own fork, for example:git clone https://github.com/<YOUR_USERNAME>/triggerx.gitOr guide users to copy the SSH/HTTPS URL from their fork’s “Clone” button.
1-1: Standardize project name casing.The title uses
TriggerXwhile elsewhere (clone URL, repo) it’s lowercasetriggerx. Confirm the official spelling and apply it consistently throughout the document.
31-34: Link to coding style or KDoc guide.Encouraging KDoc is great—consider adding a link to your Kotlin style guide or the official Kotlin documentation so contributors see examples:
* **Comments:** Add KDoc comments for all public APIs (see our [Kotlin style guide](docs/KOTLIN_STYLE_GUIDE.md) or the [official KDoc docs](https://kotlinlang.org/docs/kotlin-doc.html)).
14-17: Clarify the fork step before branching.You instruct to create a branch but don’t mention forking first. Suggest adding a note:
1. Fork the repo via GitHub UI. 2. Clone your fork and create a branch: ```bash git clone <your-fork-url> git checkout -b feature/your-awesome-feature--- `54-57`: **Verify Code of Conduct link path.** The relative link `CODE_OF_CONDUCT.md` will work in GitHub UI, but you may want to use a fully qualified link or add `./` for clarity: ```markdown [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
.github/CODEOWNERS(1 hunks).github/ISSUE_TEMPLATE/bug_report.md(1 hunks).github/ISSUE_TEMPLATE/feature_request.md(1 hunks).github/PULL_REQUEST_TEMPLATE.md(1 hunks)CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/ISSUE_TEMPLATE/bug_report.md
27-27: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
.github/PULL_REQUEST_TEMPLATE.md
37-37: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
38-38: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
39-39: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🪛 LanguageTool
CODE_OF_CONDUCT.md
[style] ~32-~32: Try using a synonym here to strengthen your wording.
Context: ...ind * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...
(COMMENT_REMARK)
[style] ~66-~66: ‘with regard to’ might be wordy. Consider a shorter alternative.
Context: ...s obligated to maintain confidentiality with regard to the reporter of an incident. Further de...
(EN_WORDINESS_PREMIUM_WITH_REGARD_TO)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...d faith may face temporary or permanent repercussions as determined by other members of the p...
(AI_HYDRA_LEO_MISSING_COMMA)
.github/PULL_REQUEST_TEMPLATE.md
[style] ~18-~18: Consider using a different verb for a more formal wording.
Context: ... [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaki...
(FIX_RESOLVE)
🔇 Additional comments (3)
.github/CODEOWNERS (1)
1-2: CODEOWNERS assignment is correct.
The wildcard rule (*) covers the entire repo and routes reviews to @cavin-macwan and @meticha-admin as intended..github/ISSUE_TEMPLATE/bug_report.md (1)
1-6: Front matter is correctly configured.
The YAML header (name,about,title,labels,assignees) follows GitHub’s issue-template spec..github/PULL_REQUEST_TEMPLATE.md (1)
1-7: Front matter layout looks good.
The initial YAML header fields will drive the PR template UI correctly.
This commit updates the URL for creating new issues in the `CONTRIBUTING.md` file.
Key changes:
- **CONTRIBUTING.md**:
- Changed the hyperlink for creating new issues from `https://github.com/your-username/TriggerXExample/issues/new` to `https://github.com/meticha/triggerx/issues/new`.
This ensures that contributors are directed to the correct issue tracker for the project.
|
@coderabbitai fix these neatpeaks and add that changes in this PR |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chainI'll review the files in this PR for any nitpicks and document the changes. Let me examine each file: @meticha-admin I've reviewed the files in this PR and found a few minor nitpicks to address: Issues Found:
Changes Made in This PR:📁 Repository Governance Files Added:
📋 Issue & PR Templates:
Recommendations:
This PR establishes a solid foundation for community contributions and project governance! 🚀 🏁 Script executed: Length of output: 5864 🏁 Script executed: Length of output: 1512 🏁 Script executed: Length of output: 2315 @meticha-admin Based on my analysis, here are the nitpicks to fix and the changes made in this PR: 🔧 Nitpicks to Fix:1. Inconsistent Section Headers in Issue TemplatesThe issue templates use bold text ( Fix needed in ## Describe the bug
## To Reproduce
## Expected behavior
## Screenshots
## Device Information
## Additional contextFix needed in ## Is your feature request related to a problem?
## Describe the solution you'd like
## Describe alternatives you've considered
## Additional context2. Missing Contact InformationNo email contact provided for security issues or urgent matters. Suggested addition to CONTRIBUTING.md: ## Security Issues
For security vulnerabilities, please email security@meticha.com instead of opening a public issue.3. Minor Template Improvements
📋 Changes Made in This PR:🏛️ Repository Governance
📝 Issue Templates
🔄 Pull Request Template
📖 Contribution Guidelines
✅ What's Working Well:
These templates will significantly improve the contribution experience and maintain code quality standards! 🚀 |
This commit updates the `CONTRIBUTING.md` file to include instructions on how to report security vulnerabilities.
Key changes:
- **CONTRIBUTING.md**:
- Added a new "Security Issues" section.
- Instructs users to report security vulnerabilities via email to cavin@meticha.com instead of opening public issues.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
CONTRIBUTING.md (1)
7-7: Replace hardcoded GitHub URL with a relative link
Please swap the absolute repository URL for a relative path to avoid hardcoding org/repo names.- [make one!](https://github.com/meticha/triggerx/issues/new) + [make one!](../issues/new)
🧹 Nitpick comments (3)
CONTRIBUTING.md (3)
9-9: Link the issues page for discoverability
Turn the plain text reference to the issues page into a markdown hyperlink.- feel free to ask on the project's issues page as well. + feel free to ask on the project's [issues page](../issues) as well.
41-53: Reference the Pull Request template
Explicitly link to the provided PR template to guide contributors.* Ensure your PR is made against the `main` branch (or the relevant development branch). + Use the provided [Pull Request template](.github/PULL_REQUEST_TEMPLATE.md) to ensure consistency.
65-66: Use a mailto link for the security contact
Convert the bare email address into a clickable mailto link per markdown best practices.- For security vulnerabilities, please email cavin@meticha.com instead of opening a public issue. + For security vulnerabilities, please email [cavin@meticha.com](mailto:cavin@meticha.com) instead of opening a public issue.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
65-65: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
1-4: Title and greeting are clear and welcoming
The introduction sets a positive tone and clearly states the purpose of the document.
This commit updates the Git clone URL in the CONTRIBUTING.md file.
Key changes:
- **CONTRIBUTING.md**:
- Changed the example clone URL from `https://github.com/meticha/triggerx.git` to `https://github.com/<YOUR_USERNAME>/triggerx.git`.
This modification provides a more generic placeholder for users forking the repository, guiding them to use their own username when cloning.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
CONTRIBUTING.md (1)
7-7: Replace hardcoded issue URL with relative link or placeholder
The link uses an absolute URL to the upstream repo, which may break if the org or repo is renamed. Use a relative link to the issue templates (e.g.,../issues/new?template=bug_report.md) or a placeholder with<YOUR_USERNAME>.
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
9-9: Convert plain text to hyperlink
Link the phrase "project's issues page" to the actual issues page (e.g.,../issues) for clarity and better UX.
65-65: Wrap email address in angle brackets
Markdownlint flags bare URLs; wrap the email in<and>(e.g.,<cavin@meticha.com>) to satisfy MD034.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
65-65: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
21-24: Approve placeholder fork clone URL
Using<YOUR_USERNAME>clearly instructs contributors to clone from their own fork.
2 participants
Summary by CodeRabbit
Documentation
Chores