Skip to content

docs: improve contributing guidelines - checklist, LICENSE link, grammar fixesdocs: improve contributing guidelines - add checklist items, fix LICE…#42

Open
hhyags wants to merge 1 commit intoOWASP-BLT:mainfrom
hhyags:fix-contributing-md
Open

docs: improve contributing guidelines - checklist, LICENSE link, grammar fixesdocs: improve contributing guidelines - add checklist items, fix LICE…#42
hhyags wants to merge 1 commit intoOWASP-BLT:mainfrom
hhyags:fix-contributing-md

Conversation

@hhyags
Copy link
Copy Markdown

@hhyags hhyags commented Mar 31, 2026

What this PR does

  • Added two checklist items: HTML validation and accessibility checks
  • Fixed LICENSE reference to use hyperlink AGPL-3.0
  • Fixed grammar: "Warning about" → "Warn about"
  • Fixed inconsistent branch naming conventions

Type of change

  • Documentation fix
  • Content improvement

Checklist

  • Spell-checked content
  • Follows existing style
  • No broken links introduced

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with improved branch naming conventions and streamlined submission workflows for consistency.
    • Enhanced PR checklist with new accessibility verification and HTML validation requirements.
    • Added contributor guidance for reviewing existing examples and project structures before submitting changes.
    • Clarified content guidelines for security-related documentation.
    • Updated license reference formatting for better linking.

@owasp-blt
Copy link
Copy Markdown

owasp-blt bot commented Mar 31, 2026

📊 Monthly Leaderboard

Hi @hhyags! Here's how you rank for March 2026:

Rank User Open PRs PRs (merged) PRs (closed) Reviews Comments Total
128 divyanshu-iitian @divyanshu-iitian 1 0 0 0 0 1
129 hhyags @hhyags 1 0 0 0 0 1
130 jarvis24pro-A01 @jarvis24pro-A01 1 0 0 0 0 1

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 /leaderboard on any issue or PR to see your rank!

@owasp-blt
Copy link
Copy Markdown

owasp-blt bot commented Mar 31, 2026

👋 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:

  • The PR author
  • coderabbitai
  • copilot

Once a valid peer review is submitted, this check will pass automatically. Thank you!

⚠️ Peer review enforcement is active.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 31, 2026

Walkthrough

Updated 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

Cohort / File(s) Summary
Documentation Updates
CONTRIBUTING.md
Refined branch naming convention for typo fixes, added contributor tips for instructor profiles and course structures, expanded PR checklist to include HTML validation and accessibility checks (alt text, color contrast, screen reader compatibility), updated wording for security guidelines, modified Review Process description, and linked AGPL-3.0 reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

quality: low

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is partially related to the changeset, covering key improvements (checklist, LICENSE link, grammar fixes) but appears truncated or duplicated, reducing clarity. Clarify the title by removing the apparent duplication and ensuring it's concise: e.g., 'docs: improve contributing guidelines with checklist and accessibility checks'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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 show feature/.... 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8a67c1a2-fdad-49b5-8f86-64e0713ae1db

📥 Commits

Reviewing files that changed from the base of the PR and between 4e449b0 and e33796e.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant