Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 2.13 KB
Raw

Contributing to EcoCode

Thanks for considering a contribution to EcoCode.

If you encounter a bug, have an improvement idea, or want a new feature, feel free to open a discussion or submit a PR. All constructive contributions are welcome.

Development Setup (Python Core)

  1. Create and activate a virtual environment.
  2. Install package in editable mode with dev tools:
    • python -m pip install -e .
    • python -m pip install pytest
  3. Run tests with .venv/bin/python -m pytest -q.

Local Quality Gate (required before PR)

Before opening a PR, contributors must validate that the project is healthy locally:

  1. Ensure the package installs in editable mode:
    • .venv/bin/python -m pip install -e .
  2. Ensure tests pass:
    • .venv/bin/python -m pytest -q
  3. Ensure Python sources compile:
    • .venv/bin/python -m compileall src
  4. Re-run the CLI quickly to catch obvious regressions:
    • .venv/bin/ecocode --help
    • .venv/bin/ecocode profile path/to/script.py --json
    • .venv/bin/ecocode profile path/to/script.py --collector runtime --json
    • .venv/bin/ecocode profile path/to/script.py --collector runtime --runs 3 --json
    • .venv/bin/ecocode profile path/to/script.py --collector runtime --runs 3 --max-energy-cv-pct 30 --fail-on-unstable --json
    • .venv/bin/ecocode profile-repo --root . --ext .py --include-glob "src/**/*.py" --exclude-glob "tests/*.py" --json
    • For subprocess-heavy changes, add a small runtime smoke check that spawns a child process.
    • Confirm JSON output still passes the internal schema checks for profile, baseline, repo, and trend commands.

PRs should be opened only after these checks pass.

Branch and PR Workflow

  1. Create a branch: feat/<short-name> or fix/<short-name>.
  2. Keep PRs focused and small.
  3. Add or update tests for behavior changes.
  4. Run the Local Quality Gate checks.
  5. Open a PR with context, approach, and before/after behavior.

Commit Convention

Use conventional commits:

  • feat: add cpu profiler sampler
  • fix: handle missing script in profile command
  • test: add coverage for baseline regression
  • docs: expand roadmap phase 2 milestones