Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (73 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

100 lines (73 loc) · 3 KB
Raw

Contributing to Deployah

Thank you for considering a contribution. This guide covers how to report issues, propose changes, and submit pull requests.

By participating, you agree to follow the Code of Conduct.

Where to start

Kind of contribution Where
Questions, early ideas, showcases GitHub Discussions
Bugs, feature requests, design proposals GitHub Issues
Security vulnerabilities SECURITY.md (private report only)
Code, docs, or tests Pull request against main

Search existing issues and discussions before opening a new one. Use the issue templates when they fit.

Development setup

The Nix flake is the main dev and CI interface. With direnv (the .envrc uses use flake), tools load when you enter the repo.

nix develop

Format, lint, and tidy:

nix run .#fmt
nix run .#lint
nix run .#lint-md
nix run .#tidy

Build and run:

nix build
nix run . -- --help

More detail lives in the Development section of the README.

Tests

When you add or change behavior, add or update automated tests in the same change. Prefer unit tests for focused logic, scenario tests under scenarios/ when behavior spans the deploy pipeline, and e2e coverage when the change needs a real cluster.

nix run .#test-unit
nix run .#test-integration
# Optional; needs Docker or Podman:
DEPLOYAH_E2E_FORCE=1 nix run .#test-e2e

Before you open a pull request, make sure lint and the tests you touched are clean. CI runs flake validation, lint/fmt/tidy, unit, integration, and e2e on every pull request and push to main.

Pull requests

  1. Fork the repository and create a branch from main.
  2. Make your changes with clear, focused commits.
  3. Update docs or CLI help when the change is user-facing (README.md, docs/cli/).
  4. Open a pull request and fill in the template (summary, test plan, labels).
  5. Link related work with Fixes #N or Refs #N.

Pull request titles should be short and imperative (for example, Add plan dry-run flag). Apply one of kind/feature, kind/bug, kind/docs, or kind/chore. Add breaking-change when you break existing CLI or config behavior. Add skip-changelog for internal-only work that should not appear in release notes.

Commit messages

Use a short imperative subject. Explain why in the body when the change is not obvious from the subject alone.

AI-assisted contributions

AI tools are welcome if you disclose them and stay accountable for the result.

  • You must understand and review every change you submit.
  • Say in the pull request description that AI assistance was used.
  • Optionally add an Assisted-by: <tool>/<model> trailer on commits.
  • Do not use AI to generate replies in review discussions.

License

By contributing, you agree that your contributions are licensed under the Apache License 2.0.