Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (30 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 2.73 KB

Contributing to SerialPilot

Thanks for your interest in contributing! This document covers the org-wide ground rules. Individual repos may add their own CONTRIBUTING.md with project-specific build/test instructions — when in doubt, the per-repo file wins.

Ways to help

  • 🐛 Report a bug — open an issue on the affected repo using the bug template. Include OS, Node version (or Rust toolchain), and a minimal reproduction.
  • 💡 Request a feature — open a feature-request issue describing the use case and why existing functionality isn't enough.
  • 💬 Ask a question — head to Discussions. Issues are for actionable work.
  • 📝 Improve docs — typo fixes, clarifications, and new recipes are always welcome.
  • 🔌 Send a PR — see below.

Submitting a Pull Request

  1. Fork the repo and create a branch off main. Use a descriptive branch name (e.g. fix/parser-readline-trailing-cr, feat/reconnect-jitter).
  2. Discuss large changes first. For anything beyond a small bug fix or doc change, open an issue or Discussion to align on approach before you write code. Saves everyone time.
  3. Code style — match the existing style. Run npm run lint and npm run format (Node packages) or cargo fmt && cargo clippy (Rust crate) before pushing.
  4. Tests — every behavioral change needs a test that fails before your fix and passes after. Run npm test (or cargo test). New features need new tests.
  5. Docs — if you change a public API, update the README and any relevant recipes.
  6. Changeset — for npm packages, run npm run changeset and commit the generated markdown file. This drives our release notes.
  7. Sign your commits is appreciated but not required.
  8. Rebase onto the latest main before opening the PR. Resolve conflicts cleanly.
  9. Open the PR using the template — fill in the summary, type, test plan, and checklist.

What gets merged faster

  • Small, focused changes (one concern per PR).
  • A clear "why" in the PR description.
  • Green CI on Linux, macOS, and Windows.
  • New tests covering the change.
  • Docs updated alongside the code.

License

By contributing, you agree your contributions are licensed under the MIT License, the same license that covers SerialPilot itself.

Code of Conduct

All contributors are expected to follow the SerialPilot Code of Conduct. Please read it.

Questions?

Open a Discussion or email contact@riteshrana.engineer.