Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.55 KB
Raw

Contributing

Thanks for considering a contribution to auth-web.

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

swift build
swift test
swift format lint --recursive --strict Sources Tests

Requires REDIS_HOST unset (falls back to in-memory sessions) for a quick local run, or a local Redis for parity with the deployed environment. ADMIN_API_URL defaults to an in-cluster DNS name (see AdminAPIConfig.swift) - override it to point at a reachable admin-api instance for local development against real data.

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 from develop via the "Prepare Release" workflow (workflow_dispatch), which opens a release PR with an updated CHANGELOG.md for review before tagging.