Skip to content

docs: clarify base branch strategy in CONTRIBUTING.md#80

Merged
artcava merged 1 commit intodevelopfrom
docs/clarify-base-branch-in-contributing
Apr 8, 2026
Merged

docs: clarify base branch strategy in CONTRIBUTING.md#80
artcava merged 1 commit intodevelopfrom
docs/clarify-base-branch-in-contributing

Conversation

@artcava
Copy link
Copy Markdown
Owner

@artcava artcava commented Apr 8, 2026

Summary

Closes #79

Updates CONTRIBUTING.md to explicitly state that all contributions must branch off from develop, never from master. This applies to all contribution types, including documentation-only changes.

Changes

  • Quick Start — updated steps 5 and 7 to reference develop explicitly
  • Branch Naming Convention — added a prominent callout rule at the top of the section
  • Development Setup — updated git checkout example to start from develop with git pull upstream develop
  • Before Opening a PR checklist — added two new items:
    • Branch was created from develop (not master)
    • PR targets develop (not master)
  • Documentation Improvements workflow — added the missing approval step (consistent with Bug and Feature workflows)

Motivation

Three recent PRs (#75, #76, #77) demonstrated that contributors were unclear about the expected base branch. Two out of three targeted master directly. This change makes the rule unambiguous for all future contributors.

Notes

Documentation-only change. No code or test files modified.

Closes #79

- Add explicit rule to always branch off from `develop`
- Update Development Setup git example to start from develop
- Add PR checklist item: PR targets develop (not master)
- Add approval step to Documentation Improvements workflow
@artcava artcava merged commit 4cfa0cb into develop Apr 8, 2026
8 checks passed
@artcava artcava deleted the docs/clarify-base-branch-in-contributing branch April 8, 2026 14:15
@artcava artcava mentioned this pull request Apr 8, 2026
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