HSF Training is an open source project, and we welcome contributions of all kinds: fixes to existing material, new exercises, bug reports, and reviews of proposed changes.
By contributing, you agree that we may redistribute your work under the license of this repository. Everyone involved in HSF Training agrees to abide by our code of conduct.
- Report a problem or suggest an improvement by opening an issue. Mistakes, awkward wording, outdated software and broken links are all worth reporting.
- Propose a change with a pull request:
- Fork this repository and create a branch from
master. - Make your changes and preview them locally. The website is built with
starterkit_ci buildin theenvironment.ymlenvironment, as in.github/workflows/build.yml. - Install the pre-commit hooks (
pip install pre-commit && pre-commit install) so that formatting and spelling checks run before you commit. - Open a pull request against
masterand describe what you changed and why.
- Fork this repository and create a branch from
If you're looking for ideas, see this repository's issues, or the good first issues across all HSF Training repositories.
Lesson maintainers are volunteers, so it may take a few days to get a reply. If
nobody responds, feel free to mention the previous contributors or the training
conveners (@hsf-training/training-conveners) in your issue or pull request.