-
Notifications
You must be signed in to change notification settings - Fork 38
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
FelixNicolaeBucsa
wants to merge
3
commits into
master
Choose a base branch
from
edits/add-developing-resource
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 --> |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.