Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 977 Bytes

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 977 Bytes

Contributing

Welcome! As a Jupyter targeted project, we follow the Jupyter contributor guide and Code of Conduct.

To set up a development environment for this repository:

  1. Clone this repository:

    git clone https://github.com/idiap/multiauthenticator
    
  2. Do a development install with pip

    pip install --editable ".[dev]"
  3. Set up pre-commit hooks for automatic code formatting, etc.

    pip install pre-commit
    
    pre-commit install --install-hooks

    You can also invoke the pre-commit hook manually at any time with

    pre-commit run
  4. Run tests

    pytest
    

Feel free to ask for help