Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (51 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

74 lines (51 loc) · 2.31 KB
Raw

Contributing

Meraki welcomes constructive pull requests that maintain backwards compatibility with prior versions.

Setup

# Clone and install dev dependencies
git clone https://github.com/meraki/dashboard-api-python.git
cd dashboard-api-python
uv sync

Development Workflow

  1. Create a feature branch from main
  2. Make your changes
  3. Run tests: uv run pytest tests/unit
  4. Run linting: uv run ruff check . && uv run ruff format --check .
  5. Open a pull request against main

Code Standards

  • Line length: 127 characters
  • Formatter: ruff format
  • Linter: ruff + flake8
  • Test coverage floor: 90% (core, non-generated code)
  • Python versions: 3.11+

What to Contribute

  • Bug fixes with regression tests
  • Documentation improvements
  • Test coverage improvements for non-generated code
  • Performance improvements with benchmarks

What Not to Modify

  • Generated API scope files (meraki/api/, meraki/aio/api/) are auto-generated from the OpenAPI spec. Changes here will be overwritten. Fix the generator instead.
  • Do not vendor or bundle dependencies.

Changelog Fragments

Every user-facing change needs a news fragment in changelog.d/. Do not edit CHANGELOG.md by hand; towncrier builds it at release time.

File name: changelog.d/{issue}.{type}.md. With no issue, use a slug prefixed with +: changelog.d/+httpx-migration.changed.md.

Types: added, changed, deprecated, removed, fixed, security.

# Issue-linked
echo "Retry on 429 now honors Retry-After." > changelog.d/1234.fixed.md

# Or via towncrier
uv run towncrier create -c "Retry on 429 now honors Retry-After." 1234.fixed.md

# Preview the rendered changelog without consuming fragments
uv run towncrier build --draft --version "$(grep '^version' pyproject.toml | sed 's/version = "\(.*\)"/\1/')"

One fragment per change. Multiple fragments per issue are fine (e.g. 1234.added.md and 1234.fixed.md). Fragments are not wiped by library regeneration; they survive until the next release build.

Running the Generator

uv sync --group generator
uv run python generator/generate_library.py

Questions