fix(#20): Add Definition of Done to CONTRIBUTING.md and TESTING.md
Some checks are pending
Docker Test / test (push) Waiting to run
Some checks are pending
Docker Test / test (push) Waiting to run
This commit is contained in:
parent
2b09cf05eb
commit
58424f0530
2 changed files with 63 additions and 0 deletions
48
CONTRIBUTING.md
Normal file
48
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
# 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.
|
||||||
15
docs/testing.md
Normal file
15
docs/testing.md
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
# Testing
|
||||||
|
|
||||||
|
This document describes the testing strategy for the project.
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
For more details on how to run tests, see the [CONTRIBUTING.md](../CONTRIBUTING.md) file.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue