Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.52 KB
Raw

MAL is currently looking for contributors. The project is primarly done in Python, but all skills and levels are welcome as there are many ways in which you can help, such as documenting, testing/opening new issues, solving bugs, developing new features and many others. If you are not sure whether your skill is or not needed, please open a new issue here. Also feel free to open new issues for any bugs you find, features you think would be nice to have or questions in general.

Steps for Contributing

    1. Find an issue here.
    1. Verify if the chosen issue is not already in WIP (create a new issue if needed).
    1. Mention (by commenting on the issue) that you want to take it.
    1. Fork it and create a new branch out of master.
    1. Work on it.
    1. Submit a pull request.

Setting up mal for development

Setup a virtualenv and run:

python -m venv venv
source venv/bin/activate
python install -r requirements.txt
python setup.py develop

In development mode an EGG file is linked with the actual source so that you can modify and test it without the need of reinstalling it.

For more information see Development Mode.

Running mal without installing it

Inside the project run:

PYTHONPATH=. python mal/cli.py

PYTHONPATH variable is set to look inside the project so it will look for the local module mal before it looks for a installed mal.