dev-workflow

Development workflow – Contentstack Management Python

When to use

• Setting up locally, opening a PR, or matching CI expectations.
• Answering "how do we run tests?" or "what runs in CI?"

Instructions

Branches & releases

• Flow: merge work to development; release PRs are development → main. After main moves, .github/workflows/back-merge-pr.yml can open main → development to resync.
• PyPI: publish a GitHub Release (release: published) to run .github/workflows/release.yml. PRs that touch contentstack_management/ or setup.py must bump __version__ and CHANGELOG.md per .github/workflows/check-version-bump.yml.

Before a PR

1. Install — pip install -e ".[dev]" then pip install -r requirements-dev.txt for linting tools.
2. pytest tests/unit/ — required baseline (matches CI coverage run -m pytest tests/unit/).
3. API tests — pytest tests/api/ when your change affects live CMA behavior; configure .env per tests/cred.py. Never commit tokens.
4. Mock tests — pytest tests/mock/ when extending mocked HTTP or fixtures.

Packaging

• Bump contentstack_management/__init__.py __version__ and align setup.py versioning if release-facing.

Tooling

• pylint is listed in requirements-dev.txt; follow existing style in touched files.
• Husky / Talisman / Snyk — see README.md for local hook setup.

Pull requests

• Build passes: pytest tests/unit/ at minimum; run API / mock when your change touches those layers.
• Follow skills/code-review/SKILL.md before merge.
• Prefer backward-compatible public API; call out breaking changes and semver.