Skip to content

Commit 65e663a

Browse files
Add health files (#211)
Closes #136
1 parent 46f6922 commit 65e663a

7 files changed

Lines changed: 160 additions & 3 deletions

File tree

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Report a verifier bug, crash, or incorrect result
4+
labels: bug
5+
---
6+
7+
**Description**
8+
What went wrong?
9+
10+
**Minimal reproducer**
11+
```java
12+
// smallest snippet that triggers the issue
13+
```
14+
15+
**Expected behavior**
16+
What should have happened?
17+
18+
**Actual behavior**
19+
Error message, stack trace, or counterexample output.
20+
21+
**Environment**
22+
- LiquidJava version / commit:
23+
- Java version (`java -version`):
24+
- OS:
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or improvement
4+
labels: enhancement
5+
---
6+
7+
**Problem**
8+
What are you trying to do that LiquidJava doesn't support today?
9+
10+
**Proposed solution**
11+
What should it look like? Include an example annotation or API sketch if relevant.
12+
13+
**Alternatives considered**
14+
Other approaches you've thought about.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Description
2+
[Describe the changes you've made]
3+
4+
## Example
5+
[Add a code example of the change, especially if it is a new feature]
6+
7+
## Related Issue
8+
[Reference any related issue]
9+
10+
## Type of change
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Documentation update
14+
- [ ] Code refactoring
15+
16+
## Checklist
17+
- [ ] Added/updated tests under `liquidjava-example/src/main/java/testSuite/` (`Correct*` / `Error*`)
18+
- [ ] `mvn test` passes locally
19+
- [ ] Updated docs/README if behavior or API changed

CLAUDE.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,7 @@ Tests are discovered by `TestExamples#testPath` (parameterized) under `liquidjav
6262
- Single-file cases: filename starts with `Correct…` or `Error…`.
6363
- Directory cases: directory name contains the substring `correct` or `error`.
6464
- Anything else is **ignored** (so helper sources can live alongside).
65-
- Expected error for a failing case:
66-
- Single file: write the expected error title in a comment on the **first line** of the file.
67-
- Directory: place a `.expected` file in that directory containing the expected error title.
65+
- Expected errors for a failing case are declared with inline `// <Error Title>` comments on **the line where each error should be reported** (regex `//\s*(.*?\bError\b)`, case-insensitive — see `TestUtils#getExpectedErrorsFromFile`). Both the title and the line number must match, and the count of comments must equal the count of reported errors. Directory cases work the same way: the scanner walks every file in the directory; there are no `.expected` files.
6866

6967
When adding new test cases, place them under `liquidjava-example/src/main/java/testSuite/` following the naming rules above — that is the only way they get picked up.
7068

CODE_OF_CONDUCT.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Code of Conduct
2+
3+
We are committed to a friendly, safe, and welcoming environment for everyone.
4+
5+
## Expected behavior
6+
7+
- Be respectful and considerate.
8+
- Assume good intent; give constructive feedback.
9+
- Welcome newcomers and differing viewpoints.
10+
11+
## Unacceptable behavior
12+
13+
Harassment, discrimination, personal attacks, or any conduct that makes others feel unsafe.
14+
15+
## Reporting
16+
17+
Report concerns to **coolkidsfcul@gmail.com**. Reports are handled confidentially.
18+
19+
Maintainers may warn, edit, or remove contributions and contributors that violate this Code of Conduct.
20+
21+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing to LiquidJava
2+
3+
Thanks for your interest in contributing! This guide covers the essentials.
4+
5+
## Requirements
6+
7+
- Java 20+
8+
- Maven 3.6+
9+
10+
## Build & test
11+
12+
```bash
13+
mvn clean install # build everything
14+
mvn test # run the test suite
15+
```
16+
17+
Run a single test:
18+
19+
```bash
20+
mvn -pl liquidjava-verifier -Dtest=TestExamples#testMultiplePaths test
21+
```
22+
23+
Verify a single file from the CLI:
24+
25+
```bash
26+
./liquidjava path/to/File.java
27+
```
28+
29+
Code formatting runs automatically via `formatter-maven-plugin` during the `validate` phase.
30+
31+
## Adding test cases
32+
33+
Tests live under `liquidjava-example/src/main/java/testSuite/` and are auto-discovered:
34+
35+
- **Single file:** name it `Correct*.java` (should pass) or `Error*.java` (should fail).
36+
- **Directory:** include `correct` or `error` in the directory name.
37+
38+
For failing cases (file or directory), mark each expected error with an inline `// <Error Title>` comment on the same line where the error should be reported, e.g.:
39+
40+
```java
41+
int r = pos; // Refinement Error
42+
```
43+
44+
The runner matches both the title and the line number, and the number of comments must equal the number of reported errors.
45+
46+
47+
## Pull requests
48+
49+
1. Fork and create a branch from `main`.
50+
2. Add tests for your change.
51+
3. Run `mvn test` and make sure it passes.
52+
4. Open a PR describing the change and linking any related issue.
53+
54+
## Reporting issues
55+
56+
Use the issue templates. Include a minimal reproducer when possible.
57+
58+
## Code of Conduct
59+
60+
By participating you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 LiquidJava contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)