Skip to content

Add CONTRIBUTING.md and /renumber-adr skill - #207

Merged
ralphbean merged 1 commit into
fullsend-ai:mainfrom
maruiz93:contributing-guide
Apr 8, 2026
Merged

Add CONTRIBUTING.md and /renumber-adr skill#207
ralphbean merged 1 commit into
fullsend-ai:mainfrom
maruiz93:contributing-guide

Conversation

@maruiz93

@maruiz93 maruiz93 commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add CONTRIBUTING.md with social norms for PR reviews: comment resolution belongs to the author, reviewers enforce feedback via "Request
    changes"
  • Document that ADRs are immutable point-in-time records and should not be edited after acceptance
  • Add /renumber-adr Claude Code skill that detects ADR number collisions against the target branch and renumbers files + all cross-references
    before merge

Motivation

We had no written guidance on PR review etiquette, which can lead to confusion about who resolves comments and how reviewers enforce their
feedback. Similarly, concurrent ADR PRs can collide on numbers — the new skill automates detection and renumbering so contributors don't have to
do it manually.

@ralphbean ralphbean left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Only question: should we encourage the use of make lint - does pre-commit accomplish the same thing?

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Marta Anon <manon@redhat.com>
@maruiz93
maruiz93 force-pushed the contributing-guide branch from 73d5a08 to d1ae12b Compare April 8, 2026 23:46
@maruiz93

maruiz93 commented Apr 8, 2026

Copy link
Copy Markdown
Contributor Author

Only question: should we encourage the use of make lint - does pre-commit accomplish the same thing?

No, they don't do the same thing — but I think they should, so I consolidated them.

Before this change, linting was split across two commands with different scopes:

  Check                    | pre-commit | make lint            
  -------------------------|------------|----------                                                                                               
  check yaml               |     ✓      |    
  fix end of files         |     ✓      |                                                                                                         
  trailing whitespace      |     ✓      |                                                                                                         
  detect private key       |     ✓      |                                                                                                         
  check added large files  |     ✓      |                                                                                                         
  check merge conflicts    |     ✓      |                                                                                                         
  check json               |     ✓      |                                                                                                         
  check toml               |     ✓      |                                                                                                         
  mixed line ending        |     ✓      |                                                                                                         
  ruff (lint)              |     ✓      |     ✓                                                                                                   
  ruff format              |     ✓      |                                                                                                         
  ty check                 |     ✓      |     ✓                    
  bandit                   |     ✓      |                                                                                                         
  gitleaks                 |     ✓      |                      
  actionlint               |     ✓      |                                                                                                         
  go vet                   |            |     ✓
  lint ADR statuses        |            |     ✓                                                                                                   
  lint ADR numbers         |            |     ✓                                                                                                   
  lint ADR frontmatter     |            |     ✓                    
                                                                                                                        

Neither was a superset of the other, so contributors had to know which to run when.

Now all checks are pre-commit hooks, and make lint is just a shortcut for pre-commit run (staged changes). I also added make lint-all for running against every file, though I expect that'll be less commonly used.

@ralphbean

Copy link
Copy Markdown
Member

Awesome! Thank you!

@ralphbean
ralphbean added this pull request to the merge queue Apr 8, 2026
Merged via the queue into fullsend-ai:main with commit 9d2bc70 Apr 8, 2026
1 check passed
@github-actions
github-actions Bot deleted the contributing-guide branch May 10, 2026 05:53
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.

2 participants