Contributing to irorun
======================

We welcome contributions from the community! This section outlines guidelines for contributing to irorun.

Getting Started
---------------
1. **Fork the Repository:**
   Fork irorun on GitHub and clone your fork locally.

2. **Create a Feature Branch:**
   Create a new branch for your changes:

   .. code-block:: bash

      git checkout -b feature/my-new-feature

3. **Install Dependencies:**
   Follow the installation instructions in the Developer Setup section.

4. **Write Tests:**
   Ensure your contributions are accompanied by tests. irorun uses pytest, so add or update tests as needed.

Coding Standards
----------------
- Follow PEP 8 style guidelines.
- Write descriptive commit messages.
- Document new features or changes in code comments and documentation.
- Update tests and documentation if necessary.

Submitting Your Changes
-----------------------
Once your changes are ready, open a pull request against the main branch. Your pull request should:
- Pass all tests.
- Include updates to documentation (if applicable).
- Follow the coding and style guidelines.

Feedback and Code Reviews
-------------------------
Your pull request will be reviewed by maintainers. Please address feedback promptly and be prepared to make further revisions.