diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..45eeb17 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,38 @@ +## Description + +Brief description of what this PR does. + +**Related Issue:** Fixes #issue_number + +## Type of Change +- [ ] `feat` - New feature +- [ ] `fix` - Bug fix +- [ ] `docs` - Documentation update +- [ ] `style` - Code style changes (formatting) +- [ ] `refactor` - Code refactoring +- [ ] `perf` - Performance improvement +- [ ] `test` - Test additions/fixes +- [ ] `build` - Build system changes +- [ ] `ci` - CI configuration changes + +## Testing +- [ ] Unit tests added/updated +- [ ] Integration tests added/updated +- [ ] Manual testing performed +- [ ] All tests pass locally + +## Code Quality +- [ ] Code follows the C++ Manual +- [ ] No compiler warnings +- [ ] Breaking changes documented (if any) +- [ ] Documentation updated + +## AI Policy Compliance +- [ ] No AI-generated content +- [ ] Contains AI-generated code (disclosed and reviewed) + +## Checklist +- [ ] Branch is up-to-date with `main` +- [ ] Commit messages follow conventional format +- [ ] CI checks pass +- [ ] Self-review completed \ No newline at end of file diff --git a/docs/contributing/git-workflow.md b/docs/contributing/git-workflow.md index 605a53a..fa66776 100644 --- a/docs/contributing/git-workflow.md +++ b/docs/contributing/git-workflow.md @@ -8,14 +8,9 @@ This document describes the Git workflow and branching strategy for Ion Vortex. #### `main` - **Purpose**: Stable, production-ready code -- **Protection**: Requires PR, 2 approvals, passing CI -- **Direct commits**: Forbidden -- **Force push**: Forbidden - -#### `develop` (if used) -- **Purpose**: Integration branch for next release - **Protection**: Requires PR, 1 approval, passing CI - **Direct commits**: Forbidden +- **Force push**: Forbidden ### Feature Branches