Developer Guide

Developer Guide

A guide for me, and later for everyone who wants to contribute to kefir, how to properly contribute kefir.

First-time setup

In the beginning, just follow the instructions from here. But I'll still reproduce.

Clone from github

git clone https://github.com/Yourun-proger/kefir.git
cd kefir

Enable venv

On Windows:

> py -m venv env
> env\scripts\activate

On MacOS/Linux:

$ python3 -m venv env
$ . env/bin/activate

Install dev deps

pip install -r dev-requirements.txt

That's all about setup

Git flow

1. Your change
   • do your change
   • write about changes in the changelog

2. Push it to main right nooow!!!

True 2.

Run test workflow:

black kefir/ tests.py
flake8 kefir/ tests.py --ignore E501
py -m unittest

If all is OK go to 3

3. Commit changes with good commit message (len <= 35)

4. Push it to branch or to main =_=