@@ -491,6 +491,67 @@ https://github.com/msgflux/msgtrace-sdk/settings/secrets/actions
491491- ` PYPI_API_TOKEN ` - From https://pypi.org/manage/account/token/
492492- ` TEST_PYPI_API_TOKEN ` - From https://test.pypi.org/manage/account/token/
493493
494+ ## 📦 Development Setup
495+
496+ ### Setup
497+
498+ ``` bash
499+ # Clone repository
500+ git clone https://github.com/msgflux/msgtrace-sdk.git
501+ cd msgtrace-sdk
502+
503+ # Install dependencies
504+ uv sync
505+
506+ # Install with dev dependencies
507+ uv sync --group dev
508+ ```
509+
510+ ### Testing
511+
512+ ``` bash
513+ # Run tests
514+ uv run pytest -v
515+
516+ # With coverage
517+ uv run pytest -v --cov=src/msgtrace --cov-report=html
518+
519+ # Run specific test
520+ uv run pytest tests/test_attributes.py -v
521+ ```
522+
523+ ### Code Quality
524+
525+ ``` bash
526+ # Format code
527+ uv run ruff format
528+
529+ # Lint
530+ uv run ruff check
531+
532+ # Auto-fix
533+ uv run ruff check --fix
534+ ```
535+
536+ ### CI/CD
537+
538+ The project uses GitHub Actions for CI/CD:
539+
540+ - ** CI** (` ci.yml ` ) - Lint, format, test on Python 3.10-3.13
541+ - ** Validate Release** (` validate-release.yml ` ) - Security validation for releases
542+ - ** Publish** (` publish.yml ` ) - Publishes to PyPI after validation
543+ - ** Merge Bot** (` merge-bot.yml ` ) - Command-based PR merging with ` /merge ` and ` /update `
544+ - ** Stale Bot** (` stale.yml ` ) - Closes stale issues/PRs
545+ - ** Release Drafter** (` release-drafter.yml ` ) - Auto-generates release notes
546+ - ** CodeQL** (` codeql.yml ` ) - Security scanning
547+ - ** Dependabot** - Automated dependency updates
548+
549+ See [ AUTOMATION.md] ( docs/AUTOMATION.md ) for detailed automation documentation.
550+
551+ ### Release Process
552+
553+ To release a new version, use the automated release script. See the "For Maintainers: Creating Releases" section above for detailed instructions.
554+
494555## 📚 Resources
495556
496557- [ Conventional Commits] ( https://www.conventionalcommits.org/ )
@@ -499,3 +560,5 @@ https://github.com/msgflux/msgtrace-sdk/settings/secrets/actions
499560- [ Ruff Documentation] ( https://docs.astral.sh/ruff/ )
500561- [ pytest Documentation] ( https://docs.pytest.org/ )
501562- [ GitHub Actions] ( https://docs.github.com/en/actions )
563+ - [ Automation Guide] ( docs/AUTOMATION.md )
564+ - [ Roadmap] ( docs/ROADMAP.md )
0 commit comments