Skip to content

docs: add Reporting Bugs section to CONTRIBUTING.md#185

Merged
mrbrandao merged 1 commit into
LobsterTrap:mainfrom
mrbrandao:docs/contributing-bug-reporting
Jun 9, 2026
Merged

docs: add Reporting Bugs section to CONTRIBUTING.md#185
mrbrandao merged 1 commit into
LobsterTrap:mainfrom
mrbrandao:docs/contributing-bug-reporting

Conversation

@mrbrandao

@mrbrandao mrbrandao commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a Reporting Bugs section to CONTRIBUTING.md that links directly to the bug report issue template (?template=bug_report.yml)
  • Explicitly states English as the project's working language for bug reports
  • Redirects security issues to SECURITY.md

Motivation

Satisfies two OpenSSF Best Practices badge criteria:

  • [report_process] (MUST) — documented process for submitting bug reports
  • [english] (SHOULD) — project accepts bug reports in English

Part of the AAIF readiness work.

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with a new "Reporting Bugs" section providing instructions for submitting bug reports through GitHub templates, requiring English-language reports, and directing security vulnerabilities to the proper security disclosure process.

Documents bug reporting process and explicitly states
English as the working language for bug reports.
Satisfies OpenSSF Best Practices criteria
report_process (MUST) and english (SHOULD).
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: eed52272-f7f1-4361-bb13-2f32bbd25fc8

📥 Commits

Reviewing files that changed from the base of the PR and between 13ea9db and 9c9228c.

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

📝 Walkthrough

Walkthrough

This PR adds a new "Reporting Bugs" section to CONTRIBUTING.md that guides contributors on how to file bug reports using the repository's template, requires bug reports be written in English, and directs security vulnerabilities to the SECURITY.md process instead of public issues.

Changes

Contributing Documentation Update

Layer / File(s) Summary
Bug reporting section in CONTRIBUTING.md
CONTRIBUTING.md
New "Reporting Bugs" subsection instructs contributors to file GitHub bug reports using the template, write in English, and route security vulnerabilities through SECURITY.md instead of public issues.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • LobsterTrap/lola#151: Updates CONTRIBUTING.md to direct security vulnerability reports to SECURITY.md, creating parallel guidance aligned with this PR's security vulnerability handling note.

Suggested labels

documentation

Suggested reviewers

  • SecKatie
  • sergio-correia
  • rjeffman

Poem

🐰 A bug report guide for all to see,
File it well with clarity,
English words and templates true,
Security bugs? SECURITY.md is for you! 🛡️

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a 'Reporting Bugs' section to CONTRIBUTING.md documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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.

@mrbrandao mrbrandao requested review from SecKatie and rjeffman June 9, 2026 14:34
@mrbrandao mrbrandao added the documentation Improvements or additions to documentation label Jun 9, 2026

@rjeffman rjeffman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm.

@mrbrandao mrbrandao merged commit 6666aa9 into LobsterTrap:main Jun 9, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants