Skip to content

Latest commit

 

History

History
6 lines (5 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

6 lines (5 loc) · 1.98 KB

How to contribute

  • Questions: If you have a question on the use of gramm, first look through the documentation and in particular through examples.m and the corresponding html/examples.html file to see if there is not already a recipe for what you want to achieve. If not then take a look at closed issues on GitHub. Finally, if you can not find an answer there, do not hesitate to create a new issue with your question: they act as a sort of FAQ.
  • Bugs: Known bugs are left as open issues on GitHub, if you find a new one, please report it there and include a minimal working example demonstrating how the gramm results differ from what is expected.
  • Enhancements: You can propose enhancements by participating in this already existing feature wishlist thread that serves as a more general discussion and outlines what is planned next. For very specific/simple enhancements you can create separate issues on GitHub.
  • Modifications: If you want to extend the functionality of gramm, you are welcome to do so! Adding new geom_ or stat_ functions can be relatively easy due to their modular conception, while more in-depth changes might require some discussions on the internals of gramm. For discussion create a new issue or if your modifications are ready just submit a pull request. For new features, an addition to examples.m demonstrating their use is welcome. Additionally, you can make sure that your changes do not break anything by running examples.m in its entirety and comparing its output to the figures in the html/ folder. I will review the code and functionality and eventually discuss/make changes to your commit before merging when it is working satisfactorily.