Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

37 lines (29 loc) · 1.8 KB

Contributing

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.

Contributor agreement

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.

How to contribute

  • 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:
    1. Fork this repository and create a branch from master.
    2. Make your changes and preview them locally. The website is built with starterkit_ci build in the environment.yml environment, as in .github/workflows/build.yml.
    3. Install the pre-commit hooks (pip install pre-commit && pre-commit install) so that formatting and spelling checks run before you commit.
    4. Open a pull request against master and describe what you changed and why.

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.