Skip to content

chore: add OSS AI helper rules for project conventions#1917

Merged
gnodet merged 1 commit into
masterfrom
chore/oss-helper-rules
May 27, 2026
Merged

chore: add OSS AI helper rules for project conventions#1917
gnodet merged 1 commit into
masterfrom
chore/oss-helper-rules

Conversation

@gnodet

@gnodet gnodet commented May 27, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Summary

  • Add .oss-ai-helper-rules/ directory with project configuration for AI coding assistants
  • Includes project info (repo metadata, issue tracker), standards (build commands, code style), and guidelines (branch naming, commit format, merge policy)
  • Enables tools like Claude Code, Gemini CLI, and Codex to automatically discover project conventions

Summary by CodeRabbit

  • Documentation
    • Added project configuration and development guidelines documentation to support contributor and development workflows.

Review Change Stack

@gnodet
chore: add OSS AI helper rules for project conventions
450c508 
Project rule files for AI coding assistants (Claude, Gemini, Codex,
etc.) to automatically discover build commands, code style, commit
conventions, and PR policies.
@coderabbitai

coderabbitai Bot commented May 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7aefbce3-b810-49ac-a8af-086dd69d1cbd

📥 Commits

Reviewing files that changed from the base of the PR and between 1735c1f and 450c508.

📒 Files selected for processing (3)
  • .oss-ai-helper-rules/project-guidelines.md
  • .oss-ai-helper-rules/project-info.md
  • .oss-ai-helper-rules/project-standards.md
📝 Walkthrough

Walkthrough

This PR adds three new .oss-ai-helper-rules/ configuration files that establish OSS Helper rules for the jline3 project. The files define project metadata (repository identification and GitHub integration), development workflow conventions (branch naming, commit message formats, PR labeling), and build/code standards (Maven commands, formatting requirements, Java version constraints, copyright headers).

Changes

OSS Helper Rule Configuration

Layer / File(s) Summary
OSS Helper rule configuration files
.oss-ai-helper-rules/project-info.md, .oss-ai-helper-rules/project-guidelines.md, .oss-ai-helper-rules/project-standards.md		 Three rule files configure the OSS Helper tool: project-info.md defines the jline/jline3 remote pattern and GitHub repo metadata; project-guidelines.md documents branch naming, commit message formats, PR labeling conventions, and task discovery via labels; project-standards.md specifies Maven build/test/format commands, Spotless formatting rules, -Werror compiler flag, required Java versions, and copyright header requirements.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Three config files, neat and tidy,
Guide the helper through code friday,
Standards, rules, and project ways,
OSS magic for better days! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: add OSS AI helper rules for project conventions' directly and accurately summarizes the main change: adding configuration files for OSS AI helper tools. It is concise, clear, and specific about what was added.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/oss-helper-rules

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud

sonarqubecloud Bot commented May 27, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@gnodet
gnodet merged commit 147ee9c into master May 27, 2026
15 checks passed
@gnodet gnodet added this to the 4.1.3 milestone May 28, 2026
@gnodet gnodet added the chore label May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

chore

Projects

None yet

Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

1 participant

@gnodet