Skip to content

ci: add CONTRIBUTING.md and PR auto-review workflow#14

Merged
night-slayer18 merged 1 commit into
mainfrom
dev
Jul 2, 2026
Merged

ci: add CONTRIBUTING.md and PR auto-review workflow#14
night-slayer18 merged 1 commit into
mainfrom
dev

Conversation

@night-slayer18

Copy link
Copy Markdown
Owner

Summary

Adds contributor documentation and an automated PR review workflow.

📄 CONTRIBUTING.md

  • Dev environment setup
  • Conventional commit format guide with examples
  • Branching strategy (PRs target dev, not main)
  • PR checklist and size guidelines
  • Issue reporting template
  • Note that signed commits are recommended but not required

⚙️ .github/workflows/pr-check.yml

Four automated checks on every PR:

  • Lint PR title — validates conventional commit format (blocking)
  • Check description — rejects empty/short descriptions (blocking)
  • Auto-label — applies labels based on commit prefix (informational)
  • Welcome comment — posts checklist on new PR open (friendly)

- CONTRIBUTING.md with dev setup, conventional commit guide, PR
  checklist, and issue reporting template
- pr-check.yml validates PR title format (conventional commits),
  rejects empty descriptions, auto-labels by prefix, and posts a
  friendly checklist comment on new PRs

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
@night-slayer18 night-slayer18 merged commit f5f6902 into main Jul 2, 2026
11 checks passed
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

Thanks for the PR, @night-slayer18! 🎉

Before this gets reviewed, please make sure the following are checked:

  • Tests pass locally (npm test)
  • Type check passes (npm run typecheck)
  • Lint passes (npm run lint)
  • New features include tests
  • Documentation updated if needed
  • PR targets the dev branch (not main)

See CONTRIBUTING.md for full guidelines.

The CI pipeline will also run build, test, lint, and typecheck automatically.

@github-actions github-actions Bot added the ci/cd label Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant