DEVELOPING.md

Development Guidelines

• Getting the Source
• Setting up a New Development Environment
• Development
• Testing
• Contributing

Getting the Source

1. Fork the repository.

2. Clone your fork of the repository:

   git clone https://github.com/fetchai/uAgents.git

3. Define an upstream remote pointing back to the main uAgents repository:

   git remote add upstream https://github.com/fetchai/uAgents.git

Setting up a New Development Environment

The easiest way to get set up for development is to install Python (3.9 to 3.12) and poetry, and then run the following from the top-level project directory:

  cd python
  poetry install
  poetry shell
  pre-commit install

Development

When developing for uAgents make sure to have the poetry shell active. This ensures that linting and formatting will automatically be checked during git commit.

We are using Ruff with added rules for formatting and linting. Please consider adding ruff to your IDE to speed up the development process and ensure you only commit clean code.

Alternately you can invoke ruff by typing the following from within the ./python folder

  ruff check --fix && ruff format

Testing

To run tests use the following command:

  pytest

Contributing

For instructions on how to contribute to the project (e.g. creating Pull Requests, commit message convention, etc), see the contributing guide.