Skip to content

docs: add Contributing section and changelog entry for contributors ladder#238

Merged
mrizzi merged 1 commit into
mainfrom
TC-5082
Jul 7, 2026
Merged

docs: add Contributing section and changelog entry for contributors ladder#238
mrizzi merged 1 commit into
mainfrom
TC-5082

Conversation

@mrizzi

@mrizzi mrizzi commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add a Contributing section to README.md referencing CONTRIBUTING.md for contributor guidance
  • Add an [Unreleased] changelog entry for the contributors ladder infrastructure (CONTRIBUTING.md, CODEOWNERS, GitHub Issue templates)

Implements TC-5082

Summary by Sourcery

Document contributor guidance and record the new contributors ladder infrastructure in the changelog.

Documentation:

  • Add a Contributing section in the README pointing to CONTRIBUTING.md for contributor guidance, promotion criteria, and workflows.

Chores:

  • Add an Unreleased changelog entry describing the contributors ladder infrastructure including CONTRIBUTING.md, CODEOWNERS, and GitHub issue templates.

…adder

Add a Contributing section to README.md referencing CONTRIBUTING.md and
an [Unreleased] changelog entry for the contributors ladder infrastructure
(CONTRIBUTING.md, CODEOWNERS, GitHub Issue templates).

Implements TC-5082

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Assisted-by: Claude Code
@sourcery-ai

sourcery-ai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds contributor guidance documentation by introducing a Contributing section in the README that points to CONTRIBUTING.md and documenting the new contributors ladder infrastructure in the Unreleased section of the changelog.

File-Level Changes

Change Details Files
Document contributors ladder infrastructure in changelog under an Unreleased section.
  • Introduce a new 'Unreleased' section at the top of the changelog.
  • Add an 'Added' subsection describing the contributors ladder and related infrastructure (CONTRIBUTING.md, CODEOWNERS, GitHub Issue templates) and referencing the tracking ticket.
CHANGELOG.md
Expose contributor guidance and workflows from the main README.
  • Add a 'Contributing' section near the end of the README.
  • Link to CONTRIBUTING.md and briefly describe that it contains the contributors ladder, promotion criteria, and issue/PR workflows.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've found 1 issue, and left some high level feedback:

  • The changelog entry references TC-5072 while the PR description references TC-5082; align these ticket IDs so the changelog and PR point to the same tracker item.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The changelog entry references TC-5072 while the PR description references TC-5082; align these ticket IDs so the changelog and PR point to the same tracker item.

## Individual Comments

### Comment 1
<location path="CHANGELOG.md" line_range="12" />
<code_context>
+
+### Added
+
+- Contributors ladder with CONTRIBUTING.md, CODEOWNERS, and GitHub Issue templates (TC-5072)
+
 ## [0.12.2] - 2026-07-03
</code_context>
<issue_to_address>
**suggestion (typo):** Consider changing "Contributors ladder" to "contributor ladder" for more natural grammar.

"Contributors ladder" is uncommon; "contributor ladder" is the standard phrasing in documentation about contribution levels.

```suggestion
- Contributor ladder with CONTRIBUTING.md, CODEOWNERS, and GitHub Issue templates (TC-5072)
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread CHANGELOG.md
@mrizzi

mrizzi commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator Author

[sdlc-workflow/verify-pr] Re: @sourcery-ai[bot] review — Classified as suggestion — the changelog entry references TC-5072 (the Feature issue encompassing the entire contributors ladder initiative), while the PR references TC-5082 (the specific implementation Task). These are intentionally different Jira entities at different hierarchy levels. No sub-task created.

@mrizzi

mrizzi commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator Author

Verification Report for TC-5082 (commit 402e544)

Check Result Details
Review Feedback PASS 2 items classified (1 nit, 1 suggestion); no code change requests
Root-Cause Investigation N/A No sub-tasks created — nothing to investigate
Scope Containment PASS PR modifies exactly CHANGELOG.md and README.md — matches task spec
Diff Size PASS 12 lines added across 2 files — proportionate for docs-only task
Commit Traceability PASS Commit 402e544 references "Implements TC-5082"
Sensitive Patterns PASS No secrets or credentials in diff
CI Status PASS All 3 checks pass (Plugin Validation, Skill Lint, Sourcery)
Acceptance Criteria PASS 4 of 4 criteria met
Test Quality N/A No test files in PR; Eval Quality: N/A
Test Change Classification N/A No test files in PR
Verification Commands N/A No verification commands specified

Overall: PASS

All checks pass. The PR adds a Contributing section to README.md referencing CONTRIBUTING.md and an [Unreleased] changelog entry for the contributors ladder infrastructure. Review feedback from sourcery-ai[bot] was classified as non-blocking (1 nit, 1 suggestion).


This comment was AI-generated by sdlc-workflow/verify-pr v0.12.2.

@mrizzi mrizzi merged commit a2ea68e into main Jul 7, 2026
3 checks passed
@mrizzi mrizzi deleted the TC-5082 branch July 7, 2026 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant