Loading...

Contribution Guidelines

Help us improve VAST Orbit - bug reports, feature requests, and code contributions welcome!


Code Contributions

Ready to contribute code? Follow our development workflow and quality standards.


Bug Reports

Found a bug? Submit an issue with complete reproduction steps.

Report a Bug →

Requirements for bug reports:

  • Clear description of the issue

  • Steps to reproduce

  • Expected vs actual behavior

  • VAST Orbit version and Python version

  • Sample code or data (if applicable)

Important

Security issues should NOT be reported publicly. Contact us directly:

Tip

If you solve your own issue, please comment on it before closing - it helps others with similar problems!


Feature Requests

Have an idea? We’re always open to suggestions for improving VAST Orbit.

Request a Feature →

Good feature requests include:

  • Clear use case description

  • Expected behavior

  • Why it would benefit users

  • Example code (if possible)

Note

Planning to implement it yourself? Open an issue first to discuss the approach before starting work. Once approved, follow our Code Contribution.


Contribution Process

Quick overview:

  1. Open an issue - Discuss bug or feature

  2. Get approval - Wait for maintainer feedback

  3. Fork & branch - Create your feature branch

  4. Code & test - Follow our standards (see CI/CD Pipeline)

  5. Submit PR - Reference the original issue

  6. Review - Address feedback from maintainers

  7. Merge - Celebrate your contribution!


Community

Get Help:

Stay Updated:

  • Star the repo on GitHub

  • Watch for releases

  • Follow VAST Data announcements


See also