Skip to content

Contributions

Thank you for considering contributing to ROADIES! We value your input and want to make it as easy as possible to get involved. Whether you're reporting a bug, adding a feature, or improving documentation, this guide will help you understand how to contribute effectively.

Table of Contents

How to Contribute

Reporting Bugs

If you find a bug, please open an issue and include:

  • A clear description of the issue, including steps to reproduce it.
  • Screenshots or logs if applicable.

Suggesting Features

We welcome feature requests! Please open a new feature request issue and include:

  • A clear description of the feature.
  • Use a label for the issue you created - new feature request.
  • Why it would be useful and how it fits with the project’s existing features.
  • Any alternatives you've considered.

Documentation Update

If you want to suggest some updates/modifications in our documentation or, please open a new documentation issue and include:

  • Clear description of the modifications or suggested additions.
  • Use a label for the issue you created - documentation.

Submitting Changes

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Make your changes.
  4. Ensure your changes pass all tests. To check that, run the following command:

cd ROADIES
python run_roadies.py --cores 16
After running this command, if you are able to successfully create the final species tree, the changes passed the test and its ready to be pushed to the forked repository.

  1. Commit your changes (git commit -m 'Add new feature').
  2. Push your changes to your fork (git push origin feature/your-feature).
  3. Create a pull request.

Please keep your pull requests small and focused. Large pull requests are harder to review and can delay the process.

Pull Request Guidelines

  • Ensure the title is concise but descriptive.
  • Include a detailed description of what the pull request does.
  • Follow the commit message guidelines.
  • Link to any related issues or pull requests.

License

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

Contact Information

For general inquiries and support, reach out to our team.

Anshu Gupta - ang037 [at] ucsd [dot] edu

Yatish Turakhia - yturakhia [at] ucsd [dot] edu