Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 1.91 KB
Raw

Contributing

If you want to contribute to this repository here are some helpful guidelines.

Reporting bugs, feature requests, etc.

To report bugs, request new features or similar, please open an issue on the Github repository.

A good bug report includes:

  • Expected behavior
  • Actual behavior
  • Steps to reproduce (preferably as minimal as possible)
  • Possibly any output from the browser console (typically available via Ctrl + Shift + J or via F12).

Minor changes, typos etc.

Minor changes can be contributed by navigating to the relevant files on the Github repository, and clicking the "edit file" icon. By following the instructions on the page you should be able to create a pull-request proposing your changes. A repository maintainer will then review your changes, and either merge them, propose some modifications to your changes, or reject them (with a reason for the rejection).

Setting up a development environment

If you want to help resolve an issue by making some changes that are larger than that covered by the above paragraph, it is recommended that you:

  • Fork the repository on Github
  • Clone your fork to your computer
  • Run the following commands inside the cloned repository:
    • pip install -e .[dev] - This will install the Python package in development mode.
    • jupyter labextension install . - This will add the lab extension development mode.
  • Validate the install by running the tests:
    • py.test - This command will run the Python tests.
    • npm test - This command will run the JS tests.

Once you have such a development setup, you should:

  • Make the changes you consider necessary
  • Run the tests to ensure that your changes does not break anything
  • If you add new code, preferably write one or more tests for checking that your code works as expected.
  • Commit your changes and publish the branch to your github repo.
  • Open a pull-request (PR) back to the main repo on Github.