Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (31 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1.07 KB

{{ cookiecutter.project_name }} Development Notes

Environmental setup

Ensure you have docker, git, and uv installed locally, and the docker daemon is running. Then run the following command to finish the repo setup locally:

task init

Linting locally

task lint

Updating the dependencies

task update

Creating a release

Releases are created automatically by python-semantic-release based on conventional commits. The version bump is determined by your commit messages:

  • fix: commits bump patch version (0.0.x)
  • feat: commits bump minor version (0.x.0)
  • BREAKING CHANGE: in commit body bumps major version (x.0.0)

To create a release, use the release GitHub action:

Example commit messages:

# Patch release (0.0.1 -> 0.0.2)
git commit -m "fix: resolve user login issue"

# Minor release (0.0.2 -> 0.1.0)
git commit -m "feat: add user profile page"

# Major release (0.1.0 -> 1.0.0)
git commit -m "feat!: redesign authentication system

BREAKING CHANGE: The login API now requires a different payload format"