Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (35 loc) · 3.6 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 3.6 KB

Contribution guidelines for Makie

Issues

Issues should be used to report bugs, regressions, missing documentation or other things we can act on. For questions, feature requests, planning and other open ended posts, please use Discussions.

Before filing an issue please

  • check that there are no similar existing issues already (feel free to bump an existing one)
  • check that your versions are up to date
    • you can do this by forcing the latest version using ]add Makie@newest-version, where newest-version can be found on the releases page.

When filing an issue, please use one of the templates we provide and follow the given instructions.

Pull requests

We always appreciate pull requests that fix bugs, add tests, improve documentation or add new features. Please describe the intent of your pull request clearly and keep a clean commit history as far as possible.

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.

Please add tests for any new functionality that you want to add. Makie uses both reference tests that check for visual regressions, and unit tests that check correctness of functions etc. It is also appreciated if you add docstrings or documentation, and add an entry to the NEWS file.

Tests

Please ensure locally that your feature works by running the tests. To be able to run the tests, you have to dev the helper package ReferenceTests that is part of the Makie monorepo. ReferenceTests is not a registered package, so you have to do ]dev path/to/ReferenceTests.

After that you should be able to run the tests via the usual ]test commands.

Formatting

We use Runic for code formatting. You should follow the instructions in the README of Runic to format the code. If you have the runic script installed, it should be sufficient to run

$ runic --inplace src/ test/

for every workspace sub-package modified before finalizing the PR.

Seeking Help

If you get stuck, here are some options to seek help:

  • Use the REPL ? help mode.
  • Click this link to open a pre-formatted topic on the Julia Discourse Page. If you do this manually, please use the category Domain/Visualization and tag questions with Makie to increase their visibility.
  • For casual conversation about Makie and its development, have a look at the #makie channel in the Julia Slack group. Please direct your usage questions to Discourse and not to Slack, to make questions and answers accessible to everybody.