Contributing to Cosmos

Contributing individual changes

Create issue with labels for:
- cdk-cosmos (or repo worked on)
- and must have one of: bug, enhancement, breaking-change, documentation, chore
Link issue to project (e.g. Cosmos)
Must add GH issue number to commits and PRs
Fork develop branch and continue contributions from your fork.
Push your changes to your fork and create Pull Request from fork/develop to cdk-cosmos/develop
- The pull request MUST be labelled with one of: bug, enhancement, breaking-change, documentation, chore
- Also label the PR with cdk-cosmos (or repo worked on)
- Link PR to project (e.g. Cosmos)
- Ideally you should have a one to one mapping between GH issues and PRs to develop branch
- In either case list the GH issue numbers that the PR addresses either in the title or description
- If tests fail because of stale snapshots, run: yarn test -- -- -u and commit snapshots
After checks pass and PR is approved Squash Merge PR from fork/develop to cdk-cosmos/develop

Maintainers agree on at what point a release should be done
Create release PR with title Release vX.Y.Z labelled with one of: release:patch or release:minor
Merge release PR with Merge Commit from develop to master, and wait for it to be published
Fetch release notes from the latest release commit's changelog.md file.
Create new release (vX.Y.Z) and add the above notes to the release tag.