Skip to content

Commit 7177e49

Browse files
committed
Update CONTRIBUTING
1 parent 684b19e commit 7177e49

1 file changed

Lines changed: 20 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,38 @@ Thanks for your interest in contributing! This guide covers the essentials.
77
- Java 20+
88
- Maven 3.6+
99

10-
## Build & test
10+
## Build and Run
11+
12+
To build the project, run:
1113

1214
```bash
13-
mvn clean install # build everything
14-
mvn test # run the test suite
15+
mvn clean install
1516
```
1617

17-
Run a single test:
18+
Code formatting runs automatically via `formatter-maven-plugin` during the `validate` phase.
19+
20+
To verify a single file from the CLI, run:
1821

1922
```bash
20-
mvn -pl liquidjava-verifier -Dtest=TestExamples#testMultiplePaths test
23+
./liquidjava path/to/File.java
2124
```
2225

23-
Verify a single file from the CLI:
26+
## Testing
27+
28+
To run all tests, run:
2429

2530
```bash
26-
./liquidjava path/to/File.java
31+
mvn test
2732
```
2833

29-
Code formatting runs automatically via `formatter-maven-plugin` during the `validate` phase.
34+
To run specific tests, run:
35+
36+
```bash
37+
mvn -pl liquidjava-verifier -Dtest=ExpressionFormatterTest test
38+
mvn -pl liquidjava-verifier -Dtest=ExpressionSimplifierTest test
39+
mvn -pl liquidjava-verifier -Dtest=RefinementsParserTest test
40+
mvn -pl liquidjava-verifier -Dtest=VariableResolverTest test
41+
```
3042

3143
## Release
3244

0 commit comments

Comments
 (0)