CONTRIBUTING.md

How to develop on this project

ailib welcomes contributions from the community. This is basically the boiler plate python template. Just make a PR i'm sure it'll get included.

You need PYTHON3!

This instructions are for linux base systems. (Linux, MacOS, BSD, etc.)

Setting up your own fork of this repo.

• On github interface click on Fork button.
• Clone your fork of this repo. git clone [email protected]:YOUR_GIT_USERNAME/project_urlname.git
• Enter the directory cd project_urlname
• Add upstream repo git remote add upstream https://github.com/author_name/project_urlname

Setting up your own virtual environment

Run make virtualenv to create a virtual environment. then activate it with source .venv/bin/activate.

Install the project in develop mode

Run make install to install the project in develop mode.

Run the tests to ensure everything is working

Run make test to run the tests.

Create a new branch to work on your contribution

Run git checkout -b my_contribution

Make your changes

Edit the files using your preferred editor. (we recommend VIM or VSCode)

Commit your changes

This project uses conventional git commit messages.

Example: fix(package): update setup.py arguments 🎉 (emojis are fine too)

Push your changes to your fork

Run git push origin my_contribution

Submit a pull request

On github interface, click on Pull Request button.

Wait CI to run and one of the developers will review your PR.