49 lines
975 B
Markdown
49 lines
975 B
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
When contributing to this repository, please follow the Definition of Done (DoD) to ensure quality and consistency.
|
||
|
|
|
||
|
|
## Definition of Done
|
||
|
|
|
||
|
|
Each change must meet the following criteria before being merged:
|
||
|
|
|
||
|
|
- [ ] All tests pass (smoke, unit, integration)
|
||
|
|
- [ ] Security review completed
|
||
|
|
- [ ] Documentation updated
|
||
|
|
- [ ] Rollback instructions provided if applicable
|
||
|
|
- [ ] Code reviewed by at least one other team member
|
||
|
|
|
||
|
|
## Pull Request Template
|
||
|
|
|
||
|
|
Please use the following template when creating a pull request:
|
||
|
|
|
||
|
|
```
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
Brief description of what this PR does.
|
||
|
|
|
||
|
|
## Changes
|
||
|
|
|
||
|
|
- List of changes made
|
||
|
|
- Reference to related issues
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
|
||
|
|
How was this tested?
|
||
|
|
|
||
|
|
## Rollback Instructions
|
||
|
|
|
||
|
|
If this change introduces a risk, provide rollback instructions.
|
||
|
|
```
|
||
|
|
|
||
|
|
## Commit Message Format
|
||
|
|
|
||
|
|
Use the following format for commit messages:
|
||
|
|
|
||
|
|
```
|
||
|
|
<type>(<scope>): <subject>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
```
|
||
|
|
|
||
|
|
Where type is one of: feat, fix, docs, style, refactor, test, chore, revert.
|