Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.71 KB

File metadata and controls

54 lines (40 loc) · 1.71 KB

Contributing

Thanks for thinking about pitching in. Bug fixes, new services, and small documentation clean-ups are all welcome, and none of them are too small to send.

Before you start

Making changes

  • Keep service, version, and platform manifests in sync when a change spans multiple layers
  • Follow Dockerfile Development for Dockerfile changes
  • Keep docs/ in sync with behavior changes
  • Prefer focused pull requests with one coherent intent

Validate before opening a pull request

# Validate one service, or all of them
nu scripts/dockypody.nu validate --service <name>
nu scripts/dockypody.nu validate --all-services

# Run the non-image test suite
nu scripts/dockypody.nu test --suite all

# Lint documentation
nu scripts/dockypody.nu docs lint

If your change is narrower, run the smallest relevant validation command and report what you ran in the pull request.

Pull requests

When you open a pull request, say what problem you are solving and why, list the validation commands you ran, and mention anything you left for later if the change is deliberately partial.

By contributing, you agree that your contributions are licensed under AGPL-3.0-or-later, consistent with this repository.