diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..450902b --- /dev/null +++ b/CONTRIBUTING.md @@ -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: + +``` +(): + + +``` + +Where type is one of: feat, fix, docs, style, refactor, test, chore, revert. diff --git a/docs/testing.md b/docs/testing.md new file mode 100644 index 0000000..4299e9c --- /dev/null +++ b/docs/testing.md @@ -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. \ No newline at end of file