chore: add code of conduct and contributing guidelines #341
Conversation
WalkthroughThis update introduces two new documentation files: Changes
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. 🪧 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 (
|
|
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #341 +/- ##
=======================================
Coverage 89.18% 89.18%
=======================================
Files 2 2
Lines 111 111
=======================================
Hits 99 99
Misses 12 12
🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (16)
CODE_OF_CONDUCT.md (8)
1-14: Missing document scope introduction
Consider adding a brief introductory sentence explaining that this Code of Conduct applies to all project spaces (issues, pull requests, chats, meetings) and communication channels. This orients newcomers immediately.
15-27: Enhance scannability of positive examples
The bullet list is solid, but grouping under a subheader like “Positive Examples” could improve readability. E.g.:
- Add a heading before line 17:
### Positive Examples.
28-37: Refine wording for stronger impact
In “Trolling, insulting or derogatory comments, and personal or political attacks”, consider replacing “Trolling” with a more precise synonym (e.g., “provocative or insulting remarks”) to avoid repetition and sharpen the message.🧰 Tools
🪛 LanguageTool
[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)
39-49: Clarify moderation actions
It may help to list specific moderation steps (e.g., locking an issue, hiding a comment) so contributors know what to expect when enforcement occurs.
51-58: Include virtual events in scope
To cover all communication modalities, consider explicitly mentioning that the Code of Conduct applies during live or recorded project meetings and webinars.
59-67: Use a role-based reporting address
Rather than a personal email, direct reports to a project alias (e.g.,conduct@yourproject.org) to ensure continuity if maintainers change and to better protect privacy.
69-114: Add typical durations for sanctions
The graduated response levels are detailed. You could enhance clarity by specifying typical timeframes (e.g., “Temporary Ban: up to 30 days”) to set clear expectations.
124-129: Highlight available translations
The translations link is great—consider adding a brief note about which languages are currently available or linking directly to a page listing them.CONTRIBUTING.md (8)
1-5: Include “Get Started” pointers
You might add links to issue or PR templates (e.g.,ISSUE_TEMPLATE.md,PULL_REQUEST_TEMPLATE.md) so newcomers know where to begin after reading this.
6-9: Contextualize the Linus Torvalds quote
The quote is inspiring; consider a one-sentence note explaining how it informs your incremental-contribution philosophy.
10-17: Summarize key Conventional Commit rules
The external link is helpful, but listing essential rules (e.g., header format, max length, scope usage) here reduces context switching.
18-23: Specify lint and test commands
Listing the exact commands (e.g.,npm run lint,pytest --maxfail=1) helps contributors verify locally before pushing.
24-31: Illustrate “One logical change per PR”
Including a short example or linking to a sample PR demonstrating good granularity can guide contributors on scope.
32-36: Reference issue templates
Link to your existingISSUE_TEMPLATE.mdto streamline reporting and ensure requesters follow the guidelines out of the box.
37-46: Outline CI failure remediation
Briefly describe how to debug common CI errors (e.g., lint failures, test flakiness) or point to a troubleshooting doc to reduce back-and-forth.
47-53: Link to discussion channels
For quick questions, specify preferred communication channels (e.g., Slack, Discord) or discussion templates so queries don’t scatter.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(1 hunks)README.md(0 hunks)
💤 Files with no reviewable changes (1)
- README.md
🧰 Additional context used
🪛 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)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
CODE_OF_CONDUCT.md (1)
115-123: Verify link stability
Ensure the links to the Contributor Covenant and Mozilla’s ladder remain valid long-term. Consider pointing to an archived version or adding a note if the upstream URLs change.
This change is
Summary by CodeRabbit