Contributing

If you have any questions, you can write to the mail or Telegram

Fork and clone your repository

1. Fork the repository (click here to fork now)
2. Clone your forked code

   git clone https://github.com/<nickname>/Kekkai.git
   

3. Create new branch

   git branch <name_new_branch>
   

4. Switch to new branch

   git checkout <name_new_branch>
   

5. Push your commits
6. Submit a new Pull Request

Testing

Before sending a Pull Request, test the functionality. Everything should work both in Docker Compose and without it.

It is recommended to use Debugger and Debug log for testing. The logging level is changed in config.yaml

Code Style

Pylint, mypy, eslint and prettier are used as code syntax checks

Checking the Node.JS code

To check the code, you must first download the necessary libraries, which are located at the root of the project

npm install

eslint and prettier is used to check and automatically correct the Node.JS code

npx eslint .

Or add the --fix flag to automatically fix the code

Checking the Python code

To check code, you need to install libraries mypy and pylint

python3 -m pip install -U mypy

and install pylint

pip install pylint

Start check the code

for pylint:

pylint /chart/

and for mypy:

mypy /chart/