Welcome to Flu-GLUE! We appreciate your interest in contributing to our project. By contributing, you help make Flu-GLUE a better resource for the community.
- How to Contribute
- Code of Conduct
- Reporting Bugs
- Suggesting Enhancements
- Pull Requests
- Style Guide
- License
If you encounter a bug, please help us by providing detailed information. You can report bugs by:
- Checking the existing issues to see if the bug has already been reported.
- Creating a new issue, including a clear and descriptive title, steps to reproduce the bug, and any relevant error messages or screenshots.
We welcome suggestions for new features or enhancements. To suggest an enhancement:
- Check the existing issues to make sure your idea hasn't been suggested.
- Create a new issue, explaining the enhancement you'd like to see and why it would be valuable.
If you want to contribute directly to the codebase:
- Fork the repository and create a new branch for your feature or bug fix.
- Make your changes and ensure the existing tests pass.
- Add tests for your changes if applicable.
- Update the documentation to reflect your changes.
- Submit a pull request, providing a clear description of your changes and reference any related issues.
Please review and adhere to our Code of Conduct. By participating, you are expected to uphold this code. Report any unacceptable behavior to robert.gifford@glasgow.ac.uk.
Please follow the existing code style within the GLUE project to maintain consistency across the codebase.
By contributing to Flu-GLUE, you agree that your contributions will be licensed under the GNU Affero General Public License v. 3.0.
Thank you for contributing to Flu-GLUE!