Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (43 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.45 KB
Raw

Contributing

Thanks for your interest in contributing! Here's what you need to know.

Getting Started

git clone https://github.com/o4s/NASA-API-Proxy.git
cd NASA-API-Proxy
git checkout -b feature/your-feature

npm install
cargo build

Development

npm run dev              # start local dev server (http://localhost:8787)
cargo test               # run tests
cargo fmt                # format code
cargo clippy             # lint

Where to Put Things

What Where
New data type src/models.rs
New route handler in src/handlers.rs, register in src/lib.rs
Upstream NASA logic src/nasa.rs
Rate limit changes src/ratelimit.rs

Commit Messages

Use conventional commits:

feat(handlers): add /v2/nasa/apod/random endpoint
fix(ratelimit): handle D1 timeout gracefully
docs: update API examples for NeoWs

Pull Request Checklist

  • cargo test passes
  • cargo fmt -- --check passes
  • cargo clippy passes
  • Documentation updated if behavior changed
  • No merge conflicts with main

Reporting Bugs

Open an issue with: steps to reproduce, expected vs. actual behavior, and environment details (Rust version, wrangler version).

Security Issues

Do not open a public issue. See SECURITY.md.

License

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