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

We welcome contributions to Sustain-Cluster! If you are interested in contributing to the project, please follow the guidelines below.

How to Contribute
-----------------

1. **Fork the Repository**  
   Fork the Sustain-Cluster repository to your own GitHub account.

2. **Clone the Repository**  
   Clone the forked repository to your local machine:

   .. code-block:: bash

      git clone https://github.com/your-username/sustain-cluster.git

3. **Create a Branch**  
   Create a new branch for your feature or bug fix:

   .. code-block:: bash

      git checkout -b feature-or-bugfix-name

4. **Make Changes**  
   Make your changes to the codebase. Be sure to follow the existing coding style and conventions.

5. **Commit Changes**  
   Commit your changes with a clear and descriptive commit message:

   .. code-block:: bash

      git add .
      git commit -m "Description of your changes"

6. **Push Changes**  
   Push your changes to your forked repository:

   .. code-block:: bash

      git push origin feature-or-bugfix-name

7. **Create a Pull Request**  
   Open a pull request on the original Sustain-Cluster repository. Provide a clear description of what your changes do and any relevant information for the review process.

Code of Conduct
---------------

Please note that we have a Code of Conduct_. By participating in this project, you agree to abide by its terms.

Reporting Issues
----------------

If you find a bug or have a feature request, please create an issue on the GitHub Issues page_. Provide as much detail as possible to help us understand and address the issue.

Development Guidelines
----------------------

- Follow the coding style and conventions used in the existing codebase.
- Write clear and concise commit messages.
- Document your code where necessary to make it easier for others to understand.
- Ensure that your changes do not break existing functionality by running tests and validating your code.

Testing
-------

Before submitting a pull request, make sure your changes pass the existing tests and add new tests if your changes introduce new functionality.

**Thank you for contributing to Sustain-Cluster! We appreciate your support and look forward to your contributions.**

Contact
-------

If you have any questions, feedback, or need assistance, please feel free to reach out to us. We are here to help and would love to hear from you.

- **Email:** soumyendu.sarkar@hpe.com
- **GitHub Issues:** GitHub Issues page_

**Thank you for your interest in Sustain-Cluster. We look forward to your contributions and feedback!**

License
-------

Sustain-Cluster is licensed under the MIT License. For more details, please refer to the LICENSE_ file in the repository.

By contributing to Sustain-Cluster, you agree that your contributions will be licensed under the MIT License.

.. _Code of Conduct: CODE_OF_CONDUCT.md
.. _GitHub Issues page: https://github.com/HewlettPackard/dc-rl/issues
.. _LICENSE: LICENSE.md