Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (35 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 1.36 KB
Raw

Contributing

Thanks for considering a contribution to catalog-api.

Branching

This repo follows the sweetrpg platform's git-flow convention:

  • develop is the integration branch. All feature and fix branches merge here.
  • master reflects the latest released state. Nothing is committed here directly.
  • Branch names: feature/<description> for new functionality, fix/<description> for bug fixes, hotfix/<description> for urgent fixes to a released version.
git checkout develop
git pull
git checkout -b feature/my-change
# ... work, commit ...
git push -u origin feature/my-change
# open a PR: feature/my-change -> develop

Commit messages

Use Conventional Commits:

<type>(<scope>): <description>

Running checks locally

go build -v ./...
go vet ./...
go test -v -coverprofile coverage.out ./...

Full local run (with Redis cache and MongoDB) is available via scripts/run-docker-local.sh / docker/docker-compose.yml.

Pull requests

CI runs automatically on PRs targeting develop. Once checks pass and the PR is reviewed, it can be merged (auto-merge is enabled once required checks pass).

Releases

Versions are tagged automatically from develop on merge (patch bump by default). Use the "Bump version" workflow (workflow_dispatch) to cut a minor or major version instead.