Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (22 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.05 KB

Contributing

Thank you for considering contributing to Footprint!

How Can I Contribute?

Reporting Bugs

  • Check the existing issues to see if it's already been reported.
  • Use the Bug Report template if available.
  • Provide a clear, detailed description of the bug and steps to reproduce it.

Suggesting Enhancements

  • Open a new issue with a clear title and description.
  • Explain why this enhancement would be useful to most users.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes (go test ./...).
  5. Format your code with gofmt.

Style Guide

  • Follow standard Go idioms and naming conventions.
  • Keep pull requests focused on a single change.
  • Write descriptive commit messages.

Architectural Principles

Please respect the core architectural principles documented in the README (Semantic ViewModel, Centralized Layout, etc.) when modifying the rendering or scoring layers.