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.

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

Jump to bottom

docs: update contributing guidelines #10926

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs: update contributing guidelines #10926

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0c4290
docs: update CONTRIBUTING.md
goffxnca Nov 7, 2024
025abd9
chore: remove unused new lines
goffxnca Nov 7, 2024
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
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,19 @@ Don't forget to setup your IDE with `eslint` and `prettier`.
- **views** contains building blocks for each page. The entry point of a view is used as the root component of each route.
- **config** contains all the config files and ABIs.
- **state** contains the redux files for the global state of the app.
- **context** contains global contexts (separated from the redux store)
- **contexts** contains global contexts (separated from the redux store)
- **hooks** contains generic hooks.
- **utils** contains generic utilities functions.
- **pages** contains page components for next.js
- **middlewares** contains functions for intercepting requests, managing user sessions and applying custom routing logic.

## Tests

Run tests with `pnpm test`.
- Run overall unit tests locally with `pnpm test:ci`, which will execute available tests across all projects under `apps` directory.
- For configuration changes (e.g., farms and pools data), use `pnpm test:config` to verify consistency with on-chain data.
- For end-to-end testing, use `pnpm e2e:ci` to build the `web` app and run end to end tests under the `e2e` project on top of it.

> **Note:** Unit tests and configuration tests are automatically triggered during pull requests to `develop` or when configuration files are updated. However, running unit tests locally before opening a PR is recommended to catch issues early.

## Issue reports

Expand Down Expand Up @@ -72,5 +77,3 @@ Reproducibility rate:

**Expected result:**
```

A good bug report shouldn't leave others needing to chase you up for more.
Loading