Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (19 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.81 KB

Contributing

Thanks for helping improve SyncBot.

Branching (upstream vs downstream)

The upstream repository (F3Nation-Community/syncbot) is the shared codebase. Each deployment maintains its own fork:

Branch Role
main Tracks upstream. Use it to merge PRs and to sync with the upstream repository (git pull upstream main, etc.).
test / prod On your fork, use these for deployments: GitHub Actions deploy workflows run on push to test and prod (see docs/DEPLOYMENT.md).

Typical flow: develop on a feature branch → open a PR to main → merge → when ready to deploy, merge main into test or prod on your fork.

Workflow

  1. Fork the repository and create a branch from main.
  2. Open a pull request targeting main on the upstream repo (or the repo you were asked to contribute to).
  3. Keep application code provider-neutral: put cloud-specific logic only under infra/<provider>/ and in deploy-<provider>.yml workflows. See docs/INFRA_CONTRACT.md (Fork Compatibility Policy).

Before you submit

  • Run pre-commit run --all-files (install with pip install pre-commit && pre-commit install if needed).
  • Ensure CI passes: requirements export check, SAM template lint, and tests (see .github/workflows/ci.yml).
  • If you change dependencies in pyproject.toml, refresh the lockfile and syncbot/requirements.txt as described in docs/DEVELOPMENT.md.

Questions

Use GitHub Issues for bugs and feature ideas, or check docs/DEPLOYMENT.md for deploy-related questions.