Contribute

PixieDust is under active development and welcomes contributions and participations from all individuals regardless of skill level. Whether you like to review documentation or implement new features, there’s a lot you can do.

Create an Issue

Create an issue if you find:

  • any problems that you are unable to fix
  • documentation that’s hard to follow
  • inconsistencies in code, user interface, or documentation

You can create issues in the PixieDust GitHub repository. To minimize duplicates, please review exising issues and search for your problem before creating a new issue.

Create a Pull Request

If you’re pitching in and fixed an issue or added a new feature (bravo!) please submit a pull request. All pull requests are welcome and will be reviewed by the PixieDust maintainers before being accepted/merged.

If you’re new to GitHub or unfamiliar with pull requests, watch the How to Contribute to an Open Source Project on GitHub video series.

Here are the steps for working with the PixieDust GitHub repository. (These instructs assume you have PixieDust set up and are ready to start development).

  1. If you haven’t already, fork the PixieDust repository.
  2. Create a branch for your changes.
  3. Make the edits in your branch.
  4. Test to make sure your changes do not break existing behavior.
  5. Repeat steps 3 and 4 until you are ready to submit your updates.
  6. Submit a pull request.

Note

While you work, regularly pull in changes from the PixieDust ‘master’ stream so you stay up-to-date and minimize merge conflicts when you submit your pull request. See detailed instructions.

Where we need help

Here are the visualizations and renderers we have so far:

  Bar Chart Pie Chart Line Graph Scatter Plot Histogram Map
matplotlib
Seaborn       NA
Bokeh   NA
MapBox NA NA NA NA NA
Google Maps NA NA NA NA NA

Choose a project, pitch in, and help us complete every component here. Or come up with your own enhancement. Let us know. We’d love to see your work.