docs: improve contributing guidelines - checklist, LICENSE link, grammar fixesdocs: improve contributing guidelines - add checklist items, fix LICE…#42
Conversation
…NSE link, grammar fixes
📊 Monthly LeaderboardHi @hhyags! Here's how you rank for March 2026:
Scoring this month (across OWASP-BLT org): Open PRs (+1 each), Merged PRs (+10), Closed (not merged) (−2), Reviews (+5; first two per PR in-month), Comments (+2, excludes CodeRabbit). Run |
|
👋 Hi @hhyags! This pull request needs a peer review before it can be merged. Please request a review from a team member who is not:
Once a valid peer review is submitted, this check will pass automatically. Thank you!
|
WalkthroughUpdated CONTRIBUTING.md documentation to refine contribution guidelines with more specific branch naming formats, added tips for reviewing existing contributor and course examples, expanded the PR checklist with HTML and accessibility verification items, and improved formatting consistency throughout the document. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
39-42: Consider clarifying branch-prefix convention across the doc.This section now uses
fix/..., while later setup examples still showfeature/.... If both are valid, add a short note so contributors know when to use each.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 39 - 42, The CONTRIBUTING.md uses two different branch prefixes (`fix/...` in the shown steps and `feature/...` elsewhere); add a brief clarification note near the branch creation step explaining the convention and when to use each prefix (e.g., use `fix/...` or `hotfix/...` for bugfixes/typos and `feature/...` for new features or larger changes) so contributors know which prefix to pick; update the text around the `git checkout -b fix/course-name-typo` example to mention this convention and, if both are valid, state that either may be used per the change type.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 39-42: The CONTRIBUTING.md uses two different branch prefixes
(`fix/...` in the shown steps and `feature/...` elsewhere); add a brief
clarification note near the branch creation step explaining the convention and
when to use each prefix (e.g., use `fix/...` or `hotfix/...` for bugfixes/typos
and `feature/...` for new features or larger changes) so contributors know which
prefix to pick; update the text around the `git checkout -b
fix/course-name-typo` example to mention this convention and, if both are valid,
state that either may be used per the change type.
What this PR does
Type of change
Checklist
Summary by CodeRabbit