You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+30-10Lines changed: 30 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing
2
2
3
-
Thanks for your interest in improving this project.
3
+
Thanks for your interest in improving this project. Below you'll find everything you need to get started.
4
4
5
5
## Prerequisites
6
6
@@ -24,27 +24,47 @@ Thanks for your interest in improving this project.
24
24
25
25
3. Open http://localhost:8080
26
26
27
+
4. Verify the build (compile + test):
28
+
29
+
```bash
30
+
mvn verify -f sample-app/pom.xml
31
+
```
32
+
27
33
## Project conventions
28
34
29
35
- Keep the code framework-agnostic (no Spring or other web frameworks).
30
36
- Use Java module system (`module-info.java`) patterns already in the project.
31
37
- Prefer small, focused classes and methods.
32
38
- Keep frontend changes in `sample-app/src/main/resources/static/`.
33
39
34
-
## Pull requests
40
+
## Reporting issues
41
+
42
+
Before opening a new issue, please search existing issues to avoid duplicates.
43
+
44
+
Use the appropriate issue template:
35
45
36
-
- Use a clear title and description explaining the problem and solution.
37
-
- Keep PRs scoped to one concern when possible.
38
-
- Update documentation (`README.md`, this file) when behavior or commands change.
39
-
- Ensure the project builds before submitting:
46
+
-**Bug report** – something isn't working as expected.
47
+
-**Feature request** – you have an idea for an improvement or new capability.
48
+
49
+
Provide as much context as possible: steps to reproduce, expected vs. actual behavior, Java and Maven versions, and any relevant logs or screenshots.
50
+
51
+
## Pull request process
52
+
53
+
1. Fork the repository and create a branch from `main` (e.g. `fix/my-bug` or `feat/my-feature`).
54
+
2. Make your changes, keeping the PR scoped to a single concern.
55
+
3. Ensure the project builds and tests pass:
56
+
57
+
```bash
58
+
mvn verify -f sample-app/pom.xml
59
+
```
40
60
41
-
```bash
42
-
mvn verify -f sample-app/pom.xml
43
-
```
61
+
4. Update `README.md` or this file if behavior or commands change.
62
+
5. Open the pull request against `main`, fill in the PR template, and link any related issues.
63
+
6. A maintainer will review your PR. Please respond to review comments promptly; PRs with no activity for 30 days may be closed.
44
64
45
65
## Code of conduct
46
66
47
-
Please be respectful and constructive in discussions and reviews.
67
+
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and constructive in all discussions and reviews.
0 commit comments