From a6e3235c96338678cad2771e3c2e5706fc14c04b Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 24 Feb 2026 04:28:11 +0000 Subject: [PATCH 1/2] Initial plan From 1b3883d7799f838a2874e717f4b63aff89f0a0a7 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 24 Feb 2026 04:30:02 +0000 Subject: [PATCH 2/2] chore: add issue/PR templates and expand CONTRIBUTING.md for OSPO readiness Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 22 +++++++++++++ CONTRIBUTING.md | 40 +++++++++++++++++------ 4 files changed, 110 insertions(+), 10 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..31b0cbd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Report a problem with this project +title: "[Bug] " +labels: bug +assignees: '' +--- + +## Describe the bug + +A clear and concise description of the problem. + +## Steps to reproduce + +1. Go to '...' +2. Run '...' +3. See error + +## Expected behavior + +What you expected to happen. + +## Actual behavior + +What actually happened. + +## Environment + +- OS: [e.g. macOS 14, Ubuntu 22.04] +- Java version: [e.g. 25] +- Maven version: [e.g. 3.9.6] + +## Additional context + +Add any other context, logs, or screenshots here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..68a7c29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an improvement or new feature +title: "[Feature] " +labels: enhancement +assignees: '' +--- + +## Problem statement + +Describe the problem or gap this feature would address. + +## Proposed solution + +A clear and concise description of what you'd like to see added or changed. + +## Alternatives considered + +Any alternative solutions or workarounds you've considered. + +## Additional context + +Any other context, screenshots, or examples that help illustrate the request. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..20e4708 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +## Description + +Briefly describe the change and the problem it solves. Link any related issues (e.g. `Closes #123`). + +## Type of change + +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Refactor / cleanup +- [ ] Other (describe): + +## How to test + +Steps for reviewers to verify the change works as expected. + +## Checklist + +- [ ] The project builds without errors (`mvn verify -f sample-app/pom.xml`) +- [ ] Code follows the project conventions described in `CONTRIBUTING.md` +- [ ] Documentation (`README.md`, `CONTRIBUTING.md`) updated if behavior or commands changed +- [ ] Self-review of the diff completed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5855d02..36347fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Thanks for your interest in improving this project. +Thanks for your interest in improving this project. Below you'll find everything you need to get started. ## Prerequisites @@ -24,6 +24,12 @@ Thanks for your interest in improving this project. 3. Open http://localhost:8080 +4. Verify the build (compile + test): + + ```bash + mvn verify -f sample-app/pom.xml + ``` + ## Project conventions - Keep the code framework-agnostic (no Spring or other web frameworks). @@ -31,20 +37,34 @@ Thanks for your interest in improving this project. - Prefer small, focused classes and methods. - Keep frontend changes in `sample-app/src/main/resources/static/`. -## Pull requests +## Reporting issues + +Before opening a new issue, please search existing issues to avoid duplicates. + +Use the appropriate issue template: -- Use a clear title and description explaining the problem and solution. -- Keep PRs scoped to one concern when possible. -- Update documentation (`README.md`, this file) when behavior or commands change. -- Ensure the project builds before submitting: +- **Bug report** – something isn't working as expected. +- **Feature request** – you have an idea for an improvement or new capability. + +Provide as much context as possible: steps to reproduce, expected vs. actual behavior, Java and Maven versions, and any relevant logs or screenshots. + +## Pull request process + +1. Fork the repository and create a branch from `main` (e.g. `fix/my-bug` or `feat/my-feature`). +2. Make your changes, keeping the PR scoped to a single concern. +3. Ensure the project builds and tests pass: + + ```bash + mvn verify -f sample-app/pom.xml + ``` - ```bash - mvn verify -f sample-app/pom.xml - ``` +4. Update `README.md` or this file if behavior or commands change. +5. Open the pull request against `main`, fill in the PR template, and link any related issues. +6. A maintainer will review your PR. Please respond to review comments promptly; PRs with no activity for 30 days may be closed. ## Code of conduct -Please be respectful and constructive in discussions and reviews. +This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and constructive in all discussions and reviews. ## License