Thank you for your interest in contributing to the Combustion Toolbox repository! We warmly welcome any contributions, whether they are small tweaks or major changes, and we truly appreciate the time and effort you put into making them.
This document provides guidelines for contributing to this repository, including how to fork and clone the repository, make changes, and submit a pull request.
To contribute to this repository, please follow these steps:
- Fork this repository to your own GitHub account
- Clone it to your local machine.
https://github.com/CombustionToolbox/combustion_toolbox.git- Create a new branch for your changes:
git checkout -b my-new-branch- Make your changes to the MATLAB code and commit them to your branch:
git commit -am 'Add some new feature'- Push your changes to your forked repository:
git push origin my-new-branch- Submit a pull request to the
developbranch of this repositoryby navigating to your forked repository on GitHub and clicking the "New pull request" button. Be sure to include a clear description of the changes you have made and the rationale behind them.
Please ensure that any MATLAB code you contribute follows the same code style as the existing code in this repository. This includes:
- Using consistent variable names and indentation
- Adding comments to explain any non-obvious code using Google Python Style docstring
If you encounter a bug in this repository, please submit a detailed bug report to the Issues section of this repository. Please include steps to reproduce the bug, expected vs. actual behavior, and any relevant code snippets or screenshots.
If you have any questions or concerns about contributing to this repository, please feel free to contact us at acuadra@ing.uc3m.es. We would be happy to help!