Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (35 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 2.75 KB

Contributing to astro-tools

Thanks for your interest in contributing! This document explains how to get involved across the astro-tools organization. Individual repositories may provide their own CONTRIBUTING.md that overrides or extends these defaults.

Before you start

  • Read the Code of Conduct. Participation in astro-tools is governed by it.
  • Check the repo's open issues and discussions. Someone may already be working on what you have in mind.
  • For anything larger than a small fix, open an issue first so we can align on approach before you invest time.

Ways to contribute

  • Report bugs — open an issue using the bug report template with steps to reproduce.
  • Suggest features or improvements — open an issue using the feature request template.
  • Improve documentation — typo fixes, clarifications, and new examples are always welcome.
  • Submit code — fix bugs, implement features, add tests, or improve performance.
  • Answer questions — help others in Discussions.
  • Review pull requests — thoughtful review from the community is highly valued.

Development workflow

  1. Fork the repository and clone your fork.
  2. Create a branch with a short, descriptive name (e.g. fix-propagator-step, add-lambert-solver).
  3. Make your changes. Keep commits focused and the diff minimal.
  4. Add tests where applicable. If a repo has a test suite, your changes should pass it.
  5. Run linters/formatters configured by the repo before committing.
  6. Push to your fork and open a pull request against the default branch.
  7. Fill in the pull request template. Link related issues with Fixes #123 or Refs #123.

Commit messages

  • Use the imperative mood in the subject line: "Add Lambert solver" rather than "Added" or "Adds".
  • Keep the subject under 72 characters.
  • Use the body to explain why the change is being made when it is not obvious.
  • Reference issues (Fixes #123) where applicable.

Pull request review

  • A maintainer will review your PR as soon as possible. Please be patient — we are a volunteer community.
  • Expect feedback. Reviews are a conversation; changes requested are not a judgment of you or your work.
  • Keep PRs focused. Unrelated changes belong in separate PRs.
  • Keep your branch up to date with the base branch, using rebase or merge per the repo's convention.

Licensing

Unless a repository states otherwise, astro-tools projects are released under the MIT License. By contributing, you agree that your contributions will be licensed under the same terms.

Questions?

Open a thread in GitHub Discussions or ask in the relevant repository's issue tracker.