Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add developing resource in github repo #374

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Development Guidelines

- [Getting the Source](#get)
- [Setting up a New Development Environment](#setup)
- [Development](#dev)
- [Testing](#test)
- [Contributing](#contributing)

## <a name="get"></a> Getting the Source

<!-- markdown-link-check-disable -->
1. Fork the [repository](https://github.com/fetchai/uAgents.git).
2. Clone your fork of the repository:
<!-- markdown-link-check-enable -->

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

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

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

## <a name="setup"></a> 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](https://pypi.org/project/poetry/), and then run the following from the top-level project directory:

```bash
cd python
poetry install
poetry shell
pre-commit install
```

## <a name="dev"></a>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](https://github.com/astral-sh/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

```bash
ruff check --fix && ruff format
```

## <a name="test"></a>Testing

To run tests use the following command:

```bash
pytest
```

## <a name="contributing"></a>Contributing

<!-- markdown-link-check-disable -->
For instructions on how to contribute to the project (e.g. creating Pull Requests, commit message convention, etc), see the [contributing guide](CONTRIBUTING.md).
<!-- markdown-link-check-enable -->
31 changes: 0 additions & 31 deletions docs/CONTRIBUTING.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content of this file should be integrated with the new DEVELOPING.md.

This file was deleted.

Loading