Skip to content

Contribute 🚀¤

Do you like Declarai?

Spread the word!

  • Star ⭐ the repository
  • Share the link to the repository with your friends and colleagues
  • Watch the github repository to get notified about new releases.

Development ¤

Once you have cloned the repository, install the requirements:

Using venv

poetry install

python -m venv env
source env/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt

Documentation ¤

The documentation is built using MkDocs. To view the documentation locally, run the following command:

$ cd docs
$ mkdocs serve
INFO    -  [11:37:30] Serving on http://127.0.0.1:8000/

Testing¤

The testing framework used is pytest. To run the tests, run the following command:

pytest --cov=src

Pull Requests¤

It should be extermly easy to contribute to this project. If you have any ideas, just open an pull request and we will discuss it.

git checkout -b my-new-feature
git commit -am 'Add some feature'
git push origin my-new-feature