Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.62 KB

Contributing to Velella

Thanks for helping. This guide applies to every repository in the Velella organization unless a project has its own CONTRIBUTING.md, which takes precedence.

Before you start

  • Bugs: open an issue with the smallest input that reproduces it, what you expected, and what happened.
  • Features: open an issue first so we can agree on the shape before you write code.
  • Small fixes (typos, docs, obvious bugs): send a pull request directly.

Pull requests

  1. Fork the repository and create a branch from main.
  2. Keep each pull request to one change.
  3. Add or update tests for any behavior you change.
  4. Run the project's checks locally (see its README) and make sure they pass.
  5. Describe why the change is needed, not only what it does.

Our standards

Every project follows the same rules, and reviews check for them:

  • Exact: findings point to a file and a line.
  • Sourced: claims about the outside world (end-of-life dates, deprecations, specs) link to an authoritative source.
  • Honest: when a tool does not know, it says so. Unknown is never reported as safe.
  • Local-first: no required accounts, no telemetry without opt-in.

Using AI tools

You may use coding agents. You are responsible for every line you submit: read it, run it, and be ready to explain it.

Conduct

Be kind, be specific, and assume good faith. Harassment of any kind is not tolerated; maintainers may remove comments, issues or contributors that break this rule.

License

By contributing, you agree that your contribution is licensed under the license of the repository you are contributing to.