README.md

Contibution guidelines for Multi-Agent-io projects

Overall

• Every repo must contain a LICENSE file (We mostly use Apache License)

• Source code in /src directory, docs (README, LICENSE, Sphinx) in /docs directory, tests in /test directory

• We recommend you to use Docker (or docker-compose)

• .gitignore in every project. Must include:

  1. .DS_Store (OSX)
  2. .idea (every platform)
  3. .vscode
  4. poetry.lock and package-lock.json (OS and arch specific package builds/sources)
  5. Other language specific stuff (__pycache__, .venv, node_modules, etc)

Benefits of unified code style

This guide includes some code style recommendations as well as best practices. Following these guidelines ensures minimal level of code quality. Unified code style lets your colleagues and off-site contributors to develop compatible code for your projects, easily review your code and join the workflow easily.

Following the formatting recommendations ensures your code is easily readable and good-looking. Pretty code is easier to understand and appears more structured thus limiting the chance of an error.

General rules

We follow the popular rules that make a good code including, but not limited to: DRY , SOLID , KISS , YAGNI. Refer to "Refactoring" and "Clean code" books or their summaries for more information.

Language specific recommendations

• Reference for Python projects

• Reference for JavaScript projects

• Other languages - feel free to submit guidelines and recommendations for any other languages you are familiar with.