Skip to content

Latest commit

 

History

History
69 lines (40 loc) · 1.52 KB

CONTRIBUTING.rst

File metadata and controls

69 lines (40 loc) · 1.52 KB

Contributing to Dojo Toolkit

Dojo Toolkit is an open source project. We welcome many kinds of contributions:

  • Code patches (pull requests) and reviews
  • Documentation improvements
  • Bug reports and ideas for new features (via Github Issues)
  • New features

Asking For Help

You can ask for help by joining grupy-sanca's Telegram group @grupysanca or find us in our facebook page https://www.facebook.com/grupysanca/ There we discuss dojo-toolkit development among other things.

How to Setup Git

The django contributing docs has a nice and small tutorial explaining how to install and setup a local repository and working with github.

How to Run Dojo-Toolkit for development

Minimal Python version: 3.9.x

1. Clone the project

$ git clone https://github.com/grupy-sanca/dojo-toolkit.git

2. Create the virtual environment using Poetry

$ make install

3. Install the entrypoint script locally

$ pip install -e .

Done :-)

How to Run Dojo-Toolkit Tests

After installing the depencencies, simply run:

$ make test

Coding Style

To run the linters

$ make lint

PEP8 with line lenght up to 99 characters.