Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.13 KB

Contributing

Thanks for contributing to picvec.

Before opening a PR

  • Keep CLI behavior and defaults stable unless the change intentionally updates user-facing UX.
  • Keep reusable logic out of cmd/. Put business logic in core/ or store/.
  • Update README.md for user-visible changes. Update README.ja.md too when practical.
  • Prefer the standard library and existing dependencies before adding new ones.

Development

go test ./...
go build -o picvec

Testing

  • Prefer deterministic unit tests in core/ and store/.
  • Do not make unit tests depend on model downloads, ONNX Runtime downloads, or external services.
  • Use temp directories and temp databases instead of writing to the real home directory.

Pull Requests

  • Keep changes focused and explain the user-facing impact.
  • Add or update tests when behavior changes.
  • Update docs and examples when commands, flags, models, or workflows change.

AI Coding Agents

If you use an AI coding agent, read AGENTS.md before making changes.

License

By submitting a contribution, you agree that your work will be licensed under the MIT License.