Contributing
Welcome to the HoMi! We appreciate your interest in contributing. Before you get started, please take a moment to read and follow these contribution guidelines to ensure a smooth and collaborative development process.
Table of Contents
Getting Started
Fork the Repository
Click the “Fork” button on the GitHub repository to create your copy.
Clone Your Fork
Clone the repository to your local machine:
git clone git@github.com:sterrettJD/HoMi.git
cd HoMi
Install HoMi
pip install -e .
Contribution Workflow
Branching
Create a new branch for your contribution:
git checkout -b new-feature
Coding Standards
Please follow PEP8 standards for Python, and use informative variable, function, and rule names. Add docstrings for new rules. Please feel free to reach out to John Sterrett for style questions. The style guide for this project is currently in development.
Commit Messages
Write clear and concise commit messages. Please reference any relevant issues or pull requests in your commits.
Testing
Ensure that your changes do not break existing functionality. Write tests for new features and make sure all tests pass before submitting a pull request.
python -m pytest
Submitting Pull Requests
When you’re ready, push your changes to your forked repository and submit a pull request to the main branch of the original repository. Provide a detailed description of your changes and reference any related issues.
Code Reviews
All contributions go through a code review process. Please be responsive to feedback and be prepared to make changes to your code if necessary.
Documentation
Update the documentation if your changes affect the usage or configuration of the HoMi pipeline. Documentation is as important as code!
Code of Conduct
Please see the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Acknowledgments
Thank you for contributing to HoMi! Your time and effort make this project better for everyone.