Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 2.36 KB
Raw

Contributing to Regl-Scatterplot

👋 Welcome and thank you for considering to contribute to regl-scatterplot.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting Started

To get an overview of the tool, checkout the demos and read the README. In particular, you might find the following sections helpful:

Help! I am lost... 😭

Head over to our discussion board and we're happy to help.

Reporting Issues 🐛 or Feature Requests 💡

If you discover a bug in regl-scatterplot or have an idea for a new feature, please submit a new issue. Make sure the issue is following either the bug report or feature request template.

For questions on how to use regl-scatterplot, please use the discussion board.

Contribute Code 💅

If you have a concrete plan how to improve regl-scatterplot and have created a ticket, send us your pull requests! If you're wondering what a pull request (PR) is, please check out GitHub's how to.

A maintainer will review your pull request. Once the pull request is approved and passes continuous integration checks, we will merge it and add it to the next scheduled release.

Pull Request Checklist ✅

  • Ensure that your pull request answers the relevant questions in the pull request template.
  • Ensure that your pull requests successfully passes all continuous integration tests with GH Actions.
  • Optionally, if your pull request introduces a new feature, it'd be great to add a new demo to /example.