Skip to content

docs: update CONTRIBUTING.md to clarify branching workflow and PR sub…#970

Merged
MODSetter merged 1 commit intomainfrom
dev_mod
Mar 25, 2026
Merged

docs: update CONTRIBUTING.md to clarify branching workflow and PR sub…#970
MODSetter merged 1 commit intomainfrom
dev_mod

Conversation

@MODSetter
Copy link
Owner

@MODSetter MODSetter commented Mar 25, 2026

…mission process

Description

Motivation and Context

FIX #

Screenshots

API Changes

  • This PR includes API changes

Change Type

  • Bug fix
  • New feature
  • Performance improvement
  • Refactoring
  • Documentation
  • Dependency/Build system
  • Breaking change
  • Other (specify):

Testing Performed

  • Tested locally
  • Manual/QA verification

Checklist

  • Follows project coding standards and conventions
  • Documentation updated as needed
  • Dependencies updated as needed
  • No lint/build errors or new warnings
  • All relevant tests are passing

High-level PR Summary

This PR updates the CONTRIBUTING.md file to clarify the project's branching workflow and pull request submission process. It introduces a branch protection model where all contributor PRs must target the dev branch instead of main, with main being reserved for stable releases managed by maintainers. The documentation now includes a clear table explaining branch purposes, updated setup instructions that emphasize forking and creating branches from dev, and explicit warnings that PRs targeting main will not be accepted.

⏱️ Estimated Review Time: 5-15 minutes

💡 Review Order Suggestion
Order File Path
1 CONTRIBUTING.md

Need help? Join our Discord

Analyze latest changes

@vercel
Copy link

vercel bot commented Mar 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
surf-sense-frontend Ready Ready Preview, Comment Mar 25, 2026 8:31pm

Request Review

@MODSetter MODSetter merged commit a474c46 into main Mar 25, 2026
6 of 8 checks passed
Copy link

@recurseml recurseml bot left a comment

Choose a reason for hiding this comment

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

Review by RecurseML

🔍 Review performed on 8227d18..8d6e249

✨ No bugs found, your code is sparkling clean

✅ Files analyzed, no issues (1)

CONTRIBUTING.md

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