Skip to main content

How to contribute

Introduction​

This project is open source and we welcome contributions. This document describes how to contribute to this project.

How to contribute​

Reporting bugs​

If you find a bug, please report it by creating an issue in the GitHub Organization. Please include the following information in your bug report:

  • A description of the bug
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)
  • Browser and version (if applicable)
  • Operating system (if applicable)

Suggesting enhancements​

If you have an idea for an enhancement, please create an issue in the GitHub Organization. Please include the following information in your enhancement request:

  • A description of the enhancement
  • Why the enhancement would be useful
  • Examples of how the enhancement could be implemented

Contributing code​

If you would like to contribute code, please create a pull request in the GitHub Organization. Please include the following information in your pull request:

  • A description of the code changes
  • Why the changes are necessary
  • Screenshots (if applicable)
  • Browser and version (if applicable)

Contributing documentation​

If you would like to contribute documentation, please create a pull request in the GitHub Repository. Please include the following information in your pull request:

  • A description of the documentation changes

License​

This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

Contact​

If you have any questions, please contact us at [email protected].