Skip to content

docs: add CONTRIBUTING.md #31

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.

Sign up for GitHub

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

Open
KHHH2312 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add CONTRIBUTING.md #31

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08a1bb4
docs: add CONTRIBUTING.md
KHHH2312 Jun 1, 2026
53bc921
docs: address Copilot review feedback
KHHH2312 Jun 1, 2026
0bf4567
docs: remove H1 to strictly comply with top-level criteria and improv…
KHHH2312 Jun 1, 2026
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
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Setup
Clone the repo and install the dependencies from the project root. A working Python 3.11+ and Node 20+ environment is required.

```bash
pip install -r requirements.txt
npm install
npm --prefix frontend install
```

## Running the tests
To run the automated test suite, use the following command:

```bash
make test
```

It is also highly recommended to run the contract static checker before submitting a PR:

```bash
make lint-contract
```

## Submitting a pull request
1. Fork the repository (if not working in the main repository).
2. Create your feature branch.
3. Make sure `make test` passes locally.
4. Push to your branch and open a pull request.