Skip to content

Commit 8ccb7f8

Browse files
authored
Merge pull request #2 from github/copilot/fix-ospo-readiness-issues
chore: add issue/PR templates and expand CONTRIBUTING.md for OSPO readiness
2 parents edfea25 + 1b3883d commit 8ccb7f8

4 files changed

Lines changed: 110 additions & 10 deletions

File tree

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Report a problem with this project
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Describe the bug
10+
11+
A clear and concise description of the problem.
12+
13+
## Steps to reproduce
14+
15+
1. Go to '...'
16+
2. Run '...'
17+
3. See error
18+
19+
## Expected behavior
20+
21+
What you expected to happen.
22+
23+
## Actual behavior
24+
25+
What actually happened.
26+
27+
## Environment
28+
29+
- OS: [e.g. macOS 14, Ubuntu 22.04]
30+
- Java version: [e.g. 25]
31+
- Maven version: [e.g. 3.9.6]
32+
33+
## Additional context
34+
35+
Add any other context, logs, or screenshots here.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an improvement or new feature
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem statement
10+
11+
Describe the problem or gap this feature would address.
12+
13+
## Proposed solution
14+
15+
A clear and concise description of what you'd like to see added or changed.
16+
17+
## Alternatives considered
18+
19+
Any alternative solutions or workarounds you've considered.
20+
21+
## Additional context
22+
23+
Any other context, screenshots, or examples that help illustrate the request.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Description
2+
3+
Briefly describe the change and the problem it solves. Link any related issues (e.g. `Closes #123`).
4+
5+
## Type of change
6+
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Documentation update
10+
- [ ] Refactor / cleanup
11+
- [ ] Other (describe):
12+
13+
## How to test
14+
15+
Steps for reviewers to verify the change works as expected.
16+
17+
## Checklist
18+
19+
- [ ] The project builds without errors (`mvn verify -f sample-app/pom.xml`)
20+
- [ ] Code follows the project conventions described in `CONTRIBUTING.md`
21+
- [ ] Documentation (`README.md`, `CONTRIBUTING.md`) updated if behavior or commands changed
22+
- [ ] Self-review of the diff completed

CONTRIBUTING.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

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.
44

55
## Prerequisites
66

@@ -24,27 +24,47 @@ Thanks for your interest in improving this project.
2424

2525
3. Open http://localhost:8080
2626

27+
4. Verify the build (compile + test):
28+
29+
```bash
30+
mvn verify -f sample-app/pom.xml
31+
```
32+
2733
## Project conventions
2834

2935
- Keep the code framework-agnostic (no Spring or other web frameworks).
3036
- Use Java module system (`module-info.java`) patterns already in the project.
3137
- Prefer small, focused classes and methods.
3238
- Keep frontend changes in `sample-app/src/main/resources/static/`.
3339

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:
3545

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+
```
4060

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.
4464

4565
## Code of conduct
4666

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.
4868

4969
## License
5070

0 commit comments

Comments
 (0)