-
Notifications
You must be signed in to change notification settings - Fork 0
Refactoring/oft 4.5.0 #89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
redcatbear
wants to merge
5
commits into
main
Choose a base branch
from
refactoring/oft_4.5.0
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1ddf312
Updated OFT to version 4.5.0 and added SPDX SBOM support
redcatbear 8b70766
Added Fixed duplicate warning and defined SBOM included scopes explic…
redcatbear f57d443
Fixed file suffix.
redcatbear 76facbb
Applied code review findings.
redcatbear 81654c5
Improved readme.
redcatbear File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
| name: oft-contributor | ||
| description: Expert Java developer for maintaining and evolving the OpenFastTrace Maven Plugin. | ||
| --- | ||
|
|
||
| ### AGENTS.md — OpenFastTrace Maven Plugin | ||
|
|
||
| This file provides guidance for AI agents and LLMs working on the OpenFastTrace Maven Plugin project. | ||
|
|
||
| ### Key Commands | ||
|
|
||
| All commands should be run from the repository root. | ||
|
|
||
| | Task | Command | | ||
| |:-------------------------|:-------------------------------------------------------------------------| | ||
| | **Verify (All tests)** | `mvn verify` | | ||
| | **Build (full)** | `mvn clean package -DskipTests` | | ||
| | **Run Unit Tests** | `mvn test` | | ||
| | **Run Single Test** | `mvn test -Dtest=ClassName` | | ||
| | **Run Integration Test** | `mvn failsafe:integration-test` | | ||
| | **Check Dependencies** | `mvn versions:display-dependency-updates` | | ||
|
|
||
| ### Agent Role & Persona | ||
|
|
||
| You are an expert Java developer specializing in requirement tracing and Maven plugin development. Your goal is to help maintain and evolve the OpenFastTrace Maven Plugin, following "Clean Code" principles and ensuring high reliability. | ||
|
|
||
| ### Boundaries | ||
|
|
||
| - **Always**: | ||
| - Follow the branching strategy: `<type>/<number>_<short-description-lower-snake-case>` (e.g., `feature/533_update_agents_md`). | ||
| - **Ask First**: | ||
| - Before adding new external dependencies to `pom.xml`. | ||
| - **Never**: | ||
| - Never remove failing tests unless specifically instructed to do so. Fix the code instead. | ||
| - Never modify files in `.idea/` or other IDE-specific metadata folders. | ||
| - Never bypass `mvn verify` checks (e.g., by skipping static analysis or tests) during final validation. | ||
|
|
||
| ### Code Examples | ||
|
|
||
| #### Requirement Tagging in Java | ||
| Show coverage of a requirement (e.g., `req~trace-goal~1`) in the implementation: | ||
|
|
||
| ```java | ||
| /** | ||
| * Mojo for tracing requirements. | ||
| * // [impl->req~trace-goal~1] | ||
| */ | ||
| @Mojo(name = "trace", defaultPhase = LifecyclePhase.VERIFY, threadSafe = true) | ||
| public class TraceMojo extends AbstractMojo { | ||
| // implementation details... | ||
| } | ||
| ``` | ||
|
|
||
| ### Project Stack & Structure | ||
|
|
||
| - **Tech Stack**: Java 17+, Maven 3.8+, JUnit 5, Mockito, Hamcrest. | ||
| - **Architecture**: | ||
| - Single-module Maven project providing a Maven Plugin. | ||
| - `src/main/java`: Plugin implementation (Mojos). | ||
| - `src/test/java`: Unit tests. | ||
| - `src/test/resources`: Integration test projects and logging configuration. | ||
|
|
||
| ### Code Style & Conventions | ||
|
|
||
| - **Clean Code**: Meaningful names, small functions, single responsibility. | ||
| - **Logging**: Use `java.util.logging`. Test config: `src/test/resources/logging.properties`. | ||
|
|
||
| ### Development Workflow | ||
|
|
||
| 1. **Create Branch** (see [Boundaries](#boundaries)) | ||
| 2. **Implement**: Tag all new code with coverage markers. | ||
|
redcatbear marked this conversation as resolved.
|
||
| 3. **Verify**: `mvn -T 1C verify`. | ||
|
redcatbear marked this conversation as resolved.
|
||
| 4. **Review**: All changes require human review per `CONTRIBUTING.md`. | ||
|
|
||
| ### Agent Skills & Critical Files | ||
|
|
||
| - **Key Resources**: | ||
| - `README.md`: General overview and usage documentation. | ||
| - `CONTRIBUTING.md`: Human-AI collaboration guidelines. | ||
| - `CHANGELOG.md`: Project history. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # OpenFastTrace Project Code of Conduct | ||
|
|
||
| * Treat others with respect. | ||
| * Criticize ideas, not people. | ||
| * Back up your arguments with facts and reasoning. | ||
| * Keep discussions on topic and concise. | ||
| * Disagreements are fine — personal attacks are not. | ||
| * Help people who ask for it. We were all beginners once. | ||
| * Offer solutions, not just complaints. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Security Policy | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| We are very grateful for any security reports and see them as a valuable way to improve the quality and reliability of our codebase. As a non-profit open-source project, we appreciate the time and effort the community puts into helping us keep OpenFastTrace secure. | ||
|
|
||
| Please note that we do not offer bug bounties. | ||
|
|
||
| To report a vulnerability, please use the [GitHub Security Advisory reporting feature](https://github.com/itsallcode/openfasttrace/security/advisories/new) or contact the maintainers directly. We strive to address all security concerns in a timely and professional manner. | ||
|
|
||
| ## Software Bill of Materials (SBOM) | ||
|
|
||
| To enhance transparency and security, SPDX SBOMs (Software Bill of Materials) are included with the plugin releases starting from version 2.4.0. These files provide a comprehensive list of all components and dependencies used in the project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.