Skip to content

Commit 0240ea8

Browse files
committed
docs: add testing section to contributing.mdx
1 parent 8fea7c3 commit 0240ea8

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

website/docs/development/contributing.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Here's how to get setup for contributing to GitProxy.
77
## Setup
88
The GitProxy project relies on the following pre-requisites:
99

10-
- [Node](https://nodejs.org/en/download) (16+)
10+
- [Node](https://nodejs.org/en/download) (22+)
1111
- [npm](https://npmjs.com/) (8+)
1212
- [git](https://git-scm.com/downloads) or equivalent Git client. It must support HTTP/S.
1313

@@ -26,7 +26,12 @@ $ npm run client # Run only the UI
2626
```
2727

2828
## Testing
29-
<!-- Notes about testing methodology -->
29+
30+
Currently, we use Mocha and Chai for unit testing and Cypress for E2E testing. For more details on how to use these testing libraries, check out our [Testing documentation](testing).
31+
32+
### Patch coverage requirements
33+
34+
Newly introduced changes **must have over 80% unit test coverage**. This is enforced by our CI, and in practice, only few exceptions (such as emergency fixes) are allowed to skip this requirement. Make sure to add thorough unit tests to your PR to help reviewers approve your PR more quickly!
3035

3136
## Configuration schema
3237
The configuration for GitProxy includes a JSON Schema ([`config.schema.json`](https://github.com/finos/git-proxy/blob/main/config.schema.json)) to define the expected properties used by the application. When adding new configuration properties to GitProxy, ensure that the schema is updated with any new, removed or changed properties. See [JSON Schema docs for specific syntax](https://json-schema.org/docs).

0 commit comments

Comments
 (0)