Skip to content

Commit 46ce060

Browse files
martinfrancoismartinfrancois
committed
docs: rename readme title for ai agents
1 parent 1d6f1fe commit 46ce060

5 files changed

Lines changed: 6 additions & 5 deletions

File tree

‎CONTRIBUTING.md‎

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

3-
Thanks for helping improve Java Optionals. This project is a Tessl-compatible skill for guiding AI
4-
agents toward better Java `Optional` usage.
3+
Thanks for helping improve the Java Optional Skill. This project is a Tessl-compatible skill for
4+
guiding AI agents toward better Java `Optional` usage.
55

66
Keep changes focused on the observed failure modes: weak Optional boundaries, null-style control
77
flow, fake single-Optional collections, eager fallback work, unclear checked-IO handling,

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Java Optionals
1+
# Java Optional Skill for AI Agents
22

33
[![tessl](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi.tessl.io%2Fv1%2Fbadges%2Fmartinfrancois%2Fjava-optionals)](https://tessl.io/registry/martinfrancois/java-optionals)
44

‎docs/agents/readme.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Use this when editing `README.md`, examples, motivation wording, or user-facing
77
## Reader Rules
88

99
- Write for users first. Tessl is the install path, not the main story.
10+
- Use `Java Optional Skill for AI Agents` as the README title. Keep package and repo names unchanged.
1011
- The README should quickly make a Java developer think: "This solves a real problem I have."
1112
- Keep the README flow natural from top to bottom. People may read it in order, so avoid sections
1213
that feel like disconnected notes.

‎skills/java-optionals/SKILL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: java-optionals
33
description: Write, review, and refactor Java Optional code using best practices, improving readability, and preventing common Optional antipatterns such as null-style control flow and readability regressions. Use whenever writing, reviewing, or refactoring Java code that introduces, changes, or reasons about Optional; handles absent, missing, nullable, fallback, or default values where Optional may be appropriate; or touches isPresent/isEmpty, get/orElseThrow, orElse(null), optional.stream(), findFirst/findAny, checked exceptions inside Optional chains, or nullable control flow.
44
---
55

6-
# Java Optionals
6+
# Java Optional Skill
77

88
Use this skill before writing Java code that may introduce `Optional`, and when reviewing or
99
refactoring existing Optional code. Keep `Optional` as a clear present/absent boundary while

‎skills/java-optionals/agents/openai.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
interface:
2-
display_name: "Java Optionals"
2+
display_name: "Java Optional Skill"
33
short_description: "Optional best practices and antipattern prevention"
44
default_prompt: "Use $java-optionals when writing, reviewing, or refactoring Java code that introduces, changes, or reasons about Optional or missing/fallback values."

0 commit comments

Comments
 (0)