Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Pull Request

## Description

<!-- Provide a clear and concise description of your changes -->

## Type of Change

<!-- Mark the relevant option with an 'x' -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Code quality improvement

## Related Issues

<!-- Link to related issues using #issue_number -->

Closes #

## Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

### Build and Test

- [ ] Code builds successfully: `dotnet build --configuration Release`
- [ ] All tests pass: `dotnet test --configuration Release`
- [ ] Code produces zero warnings

### Code Quality

- [ ] Code formatting is correct: `dotnet format --verify-no-changes`
- [ ] New code has appropriate XML documentation comments
- [ ] Static analyzer warnings have been addressed

### Quality Checks

Please run the following checks before submitting:

- [ ] **Spell checker passes**: `cspell "**/*.{md,cs}"`
- [ ] **Markdown linter passes**: `markdownlint "**/*.md"`
- [ ] **YAML linter passes**: `yamllint '**/*.{yml,yaml}'`

### Testing

- [ ] Added unit tests for new functionality
- [ ] Updated existing tests if behavior changed
- [ ] All tests follow the AAA (Arrange, Act, Assert) pattern
- [ ] Test coverage is maintained or improved

### Documentation

- [ ] Updated README.md (if applicable)
- [ ] Updated ARCHITECTURE.md (if applicable)
- [ ] Added code examples for new features (if applicable)
- [ ] Updated requirements.yaml (if applicable)

## Additional Notes

<!-- Add any additional context, screenshots, or information that reviewers should know -->
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ cspell "**/*.{md,cs}"

# (Optional) Run markdown linter if you modified markdown files
markdownlint "**/*.md"

# (Optional) Run YAML linter if you modified YAML files
yamllint '**/*.{yml,yaml}'
```

All builds must complete with zero warnings, and all tests must pass.
Expand Down