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.
If you notice any bugs, such as crashing code, incorrect results or speed issues, please raise a GitHub issue.
Before filing an issue please
- check that there are no similar existing issues already
- check that your versions are up to date
If you want to report a bug, include your version and system information, as well as stack traces with all relevant information. If possible, condense your bug into the shortest example possible that the maintainers can replicate, a so called "minimal working example" or MWE.
If you want to suggest a new feature, for example functionality that other plotting packages offer already, include supplementary material such as example images if possible, so it's clear what you are asking for.
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.
For each feature you want to contribute, please file a separate PR to keep the complexity down and time to merge short. Add PRs in draft mode if you want to discuss your approach first.
- We recommend to write a Literate.jl document and place it in
docs/literate/FOLDER/FILENAME.jlwithFOLDERbeingHowTo,Explanations,TutorialsorIntro(recommended reading on the 4 categories). - Literate.jl converts the
.jlfile to a.mdautomatically and places it indocs/src/generated/FOLDER/FILENAME.md. - Edit make.jl with a reference to
docs/src/generated/FOLDER/FILENAME.md.
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.
If you get stuck, here are some options to seek help:
- Use the REPL
?help mode. - Check the Documentation.