Contributing Guide
Thank you for your interest in contributing to MISalign. Developing open source software requires many different skill sets, both coding and non-coding, and we recognize and value every contribution. Some of the different ways you can help include:
🔬 Using the software in your research.
🐛 Reporting bugs in the software.
📖 Fixing typos and improving the documentation.
🔣 Contribute data sets.
💡 Sharing example uses.
🤔 Sharing feature requests.
💻 Writing code for new features.
🚧 Refining existing features.
Note that a code of conduct applies across all spaces associated with this project. Please review it before contributing.
Pull Request Checklist
Before you submit a pull request check the following:
Testing and documentation for your additions or changes are present and working.
If you only have a Work-In-Progress or are unsure about some part of this please state it in the pull request.
The contributed code will be licensed under MISalign’s license. If you did not write the code yourself, you ensure the existing license is compatible and include the license information in the contributed files, or obtain permission from the original author to relicense the contributed code.
That your submission is compatible with MISalign’s AI Policy. Currently, MISalign is using SciPy’s AI policy, which includes a required AI declaration in the pull request description.
Contributors
Jessica Garnett 💻🔣📖💡🔬⚠️📢
This project uses the All Contributors Emoji Key for contribution acknowledgments. Other parts of the contributoring guide were drawn from pyOpenSci’s python package guide and SciPy’s CONTRIBUTING.rst.
TODO Adding new relations & images guide(Protocol implementation).