.. _contribution_guidelines:

========================
Contribution Guidelines
========================

.. include:: logo_include.rst

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.

.. toctree::
  :maxdepth: 2
  
  cicd
  contribution_guidelines_code

____

Bug Reports
--------------

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

.. button-link:: https://github.com/vast-data/VAST-Orbit/issues
   :color: primary
   :outline:
   
   Report a Bug →

**Requirements for bug reports:**

- |check| Clear description of the issue
- |check| Steps to reproduce
- |check| Expected vs actual behavior
- |check| VAST Orbit version and Python version
- |check| Sample code or data (if applicable)

.. important::

   **Security issues** should NOT be reported publicly. Contact us directly:
   
   - **Slack**: `vastsupport.slack.com <https://vastsupport.slack.com>`__
   - **Support**: File a case with VAST support

.. 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.

.. button-link:: https://github.com/vast-data/VAST-Orbit/issues
   :color: primary
   :outline:
   
   Request a Feature →

**Good feature requests include:**

- |check| Clear use case description
- |check| Expected behavior
- |check| Why it would benefit users
- |check| 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 :ref:`contribution_guidelines.code`.

____

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 :ref:`cicd`)
5. **Submit PR** - Reference the original issue
6. **Review** - Address feedback from maintainers
7. **Merge** - Celebrate your contribution!

____

Community
------------

**Get Help:**

- |i-chat| **Slack**: `vastsupport.slack.com <https://vastsupport.slack.com>`__
- |i-error| **Issues**: https://github.com/vast-data/VAST-Orbit/issues

**Stay Updated:**

- Star the repo on GitHub
- Watch for releases
- Follow VAST Data announcements

____

.. seealso::

   - :ref:`cicd` - CI/CD pipeline and quality checks
   - :ref:`contribution_guidelines.code` - Detailed coding guidelines
   - :ref:`getting_started` - Installation and setup