Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

18 lines (14 loc) · 1.67 KB
Raw

Contribution guide

Contributions are very welcome. These could be typos, bug reports, feature requests, speed optimization, better code, and better documentation. You are very welcome to raise issues and start pull requests.

Bug reports

If you notice any bugs, such as crashing code, incorrect results or speed issues, please raise a GitHub issue. The issue should contain a short description of the problem, (optimally) a minimal working example to reproduce the bug and which UnfoldSim.jl version you are using.

Code contributions (Pull requests)

When opening a pull request, please add a short but meaningful description of the changes/features you implemented. Moreover, please add tests (where appropriate) to ensure that your code is working as expected.

Adding documentation

  1. We recommend to write a Literate.jl document and place it in docs/literate/FOLDER/FILENAME.jl with FOLDER being HowTo, Explanation, Tutorial or Reference (recommended reading on the 4 categories).
  2. Literate.jl converts the .jl file to a .md automatically and places it in docs/src/generated/FOLDER/FILENAME.md.
  3. Edit make.jl with a reference to docs/src/generated/FOLDER/FILENAME.md.

Formatting (Beware of reviewdog 🐶)

We use the julia-format Github action to ensure that the code follows the formatting rules defined by JuliaFormatter.jl. When opening a pull request reviewdog will automatically make formatting suggestions for your code.