CONTRIBUTING.md

Contributing

Thanks for helping improve this project.

Quick start

1. Fork and clone the repo.
2. Create the environment:

   make env
   conda activate sagemaker-llm-optimizer

3. Run checks before opening a PR:

   make lint
   make test

Branch + commit conventions

• Use focused branches (feat/..., fix/..., docs/..., chore/...).
• Keep commits small and descriptive.
• Prefer conventional commit style (e.g., fix(ci): ..., docs: ...).

Pull requests

Please include:

• What changed and why
• Any config/runtime implications
• Validation evidence (lint/test output, benchmark dry-run output, screenshots for dashboard changes)

Benchmark-related changes

If your PR changes benchmark logic, config schema, or metrics calculations:

• Add/update tests where possible
• Mention backward-compatibility impact
• Call out any expected changes in result interpretation

Code style

• Ruff + mypy + pytest are required to pass in CI.
• Prefer explicit typing and clear comments around AWS/SageMaker side effects.

Security and sensitive data

• Never commit real secrets, tokens, .env, or account-specific identifiers.
• Use placeholders in docs and examples.
• See SECURITY.md for vulnerability reporting.