Skip to content

docs: add CONTRIBUTING.md#71

Merged
pasrom merged 1 commit into
mainfrom
docs/contributing
Apr 6, 2026
Merged

docs: add CONTRIBUTING.md#71
pasrom merged 1 commit into
mainfrom
docs/contributing

Conversation

@pasrom

@pasrom pasrom commented Apr 6, 2026

Copy link
Copy Markdown
Owner

What

Adds CONTRIBUTING.md with guidelines for contributors.

Why

External contributors (e.g. PR #68) need clear guidance on commit conventions, build testing, and beamer-specific constraints to avoid common issues.

Content

  • Commit message convention (Conventional Commits v1.0.0)
  • Seven golden rules for commits
  • Branch naming conventions
  • Clean history strategy (rebase over merge)
  • All 8 build variants and Docker testing instructions
  • PR description template (What/Why/How)
  • Review checklist
  • Beamer mode constraints
  • Do's and Don'ts

@pasrom pasrom force-pushed the docs/contributing branch 4 times, most recently from ef4a432 to 2d98ed3 Compare April 6, 2026 08:57
@pasrom pasrom changed the title docs: add CONTRIBUTING.md and update README links to main docs: add CONTRIBUTING.md Apr 6, 2026
@pasrom pasrom force-pushed the docs/contributing branch from 2d98ed3 to f5037b9 Compare April 6, 2026 09:03
@pasrom pasrom force-pushed the docs/contributing branch from f5037b9 to d4820d6 Compare April 6, 2026 09:04
@pasrom pasrom merged commit b4bcecf into main Apr 6, 2026
8 checks passed
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