Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 3 KB
Raw

Contributing to d3-sankey-diagram

Thanks for your interest in contributing to d3-sankey-diagram! 🎉

d3-sankey-diagram is a d3-based layout and diagram component for drawing Sankey diagrams.

This document is a set of guidelines for contributing to d3-sankey-diagram on GitHub. These are guidelines, not rules. This guide is meant to make it easy for you to get involved.

Participation guidelines

This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to Rick Lupton mail@ricklupton.name.

What we're working on

For an overview of what's happening, see the Roadmap. Browse some good first bugs to get started! If you have any questions please get in touch (see below).

d3-sankey-diagram is part of the floWeaver project split between 3 repositories:

  • The floWeaver Python package: data aggregation, preparation, conversion
  • The d3-sankey-diagram (this repository): layout, SVG rendering of Sankey diagrams
  • The ipysankeywidget: embed d3-sankey-diagram within Jupyter notebooks

How to submit changes

Once you've identified one of the issues above that you feel you can contribute to, you're ready to make a change to the project repository!

  1. Fork this repository. This makes your own version of this project you can edit and use.
  2. Make your changes! You can do this in the GitHub interface on your own local machine. Once you're happy with your changes...
  3. Submit a pull request. This opens a discussion around your project and lets the project lead know you are proposing changes.

First time contributing to open source? Check out this free series, How to Contribute to an Open Source Project on GitHub. If you have any problems, get in touch (see below).

Reporting bugs and share how you find using d3-sankey-diagram

We want to know if you find a bug, have trouble using d3-sankey-diagram, but also if you use it successfully! Please file bugs, requests or questions in our issue tracker, including:

  • sharing examples of how you are using d3-sankey-diagram,
  • suggestions for improving the documentation,
  • examples of things that are more difficult than they should be or don't work

Communication channels

The main communication channel is through GitHub issues. You can also use the Gitter chatroom for discussion and questions.