Skip to content

chore: Updated the Agents.md file #1020

Open
pmathew92 wants to merge 2 commits into
mainfrom
update_agentmd_file
Open

chore: Updated the Agents.md file #1020
pmathew92 wants to merge 2 commits into
mainfrom
update_agentmd_file

Conversation

@pmathew92

@pmathew92 pmathew92 commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Changes

This PR updates the AGENTS.md file and creates a new CLAUDE.md file

Checklist

Summary by CodeRabbit

  • Documentation
    • Added a new AI coding assistant guide covering project overview, standard build/test commands, repository/module mapping, Kotlin/Java style conventions, and explicit error-handling rules.
    • Documented security practices (including PKCE/DPoP, credential storage, redirect/session handling) plus release workflow and contribution boundaries.
    • Updated the agent instructions to point to the new single source of guidelines, consolidating prior guidance.

@pmathew92 pmathew92 requested a review from a team as a code owner July 13, 2026 13:13
@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The PR replaces detailed AI guidance in AGENTS.md with a pointer to a new CLAUDE.md, which documents Auth0.Android development, testing, security, contribution, release, and documentation practices.

Changes

AI contribution guidance

Layer / File(s) Summary
Guidance foundation
AGENTS.md, CLAUDE.md
AGENTS.md points to CLAUDE.md; the new document defines project context, Gradle commands, testing expectations, repository structure, and coding conventions.
Contribution and security rules
CLAUDE.md
Contribution workflows, compatibility requirements, API parity, security practices, and common pitfalls are documented.
Maintenance and release reference
CLAUDE.md
Dependency versions, release procedures, external references, documentation rules, and an agent completion checklist are added.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: documentation

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is related to the main documentation change, though it mentions only AGENTS.md and omits the added CLAUDE.md file.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update_agentmd_file

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Nitpick comments (1)
CLAUDE.md (1)

55-56: 🎯 Functional Correctness | 🔵 Trivial | 💤 Low value

Rename this to an explicit-API compilation checkauth0:compileReleaseKotlin enforces -Xexplicit-api=strict, but it does not compare against a published API baseline.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CLAUDE.md` around lines 55 - 56, Rename the documentation entry describing
auth0:compileReleaseKotlin to an explicit-API compilation check, making clear it
enforces -Xexplicit-api=strict rather than comparing against a published API
baseline. Keep the existing Gradle command unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 4-6: Update the CLAUDE.md reference in AGENTS.md to use the
portable Markdown link [CLAUDE.md](CLAUDE.md), preserving the surrounding
guidance and avoiding any other documentation changes.

In `@CLAUDE.md`:
- Around line 74-84: Update the fenced directory-tree code blocks in CLAUDE.md,
including the blocks around the authentication test layout and the additional
affected section, to specify the text language identifier. Preserve the
directory listings unchanged while changing each opening fence to use text.
- Line 660: Update the DPoP reference in the documentation list by replacing the
obsolete draft label and URL with the RFC 9449 label and official RFC 9449 link.
- Around line 478-482: Update the DPoP bullet in the documentation to describe
nonce retry handling as reducing replay risk rather than preventing replay
attacks, and note that replay protection also depends on server-enforced
freshness, request binding, key binding, and uniqueness.

---

Nitpick comments:
In `@CLAUDE.md`:
- Around line 55-56: Rename the documentation entry describing
auth0:compileReleaseKotlin to an explicit-API compilation check, making clear it
enforces -Xexplicit-api=strict rather than comparing against a published API
baseline. Keep the existing Gradle command unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a687316b-0856-4af9-a4b8-4e1aeb7be9e3

📥 Commits

Reviewing files that changed from the base of the PR and between 6208c76 and c1381c7.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md

Comment thread AGENTS.md Outdated
Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md
Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md

9. **Generic exception catches hiding bugs:**
- `catch (e: Exception)` masks specific errors (network, auth, storage)
- Makes debugging difficult and error handling unreliable

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How are v4 changes embedded in this @pmathew92 ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What changes are you exactly referring to ? This is more of a generic handling steps

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I was referring to what we want claude to load at the start of the session as context specifically things added as part of v4.

@pmathew92 pmathew92 force-pushed the update_agentmd_file branch from 439f360 to ab0446f Compare July 13, 2026 13:34
@pmathew92 pmathew92 changed the title chore: Updated the Agents.md file with the new changes chore: Updated the Agents.md file Jul 13, 2026
@NandanPrabhu

Copy link
Copy Markdown
Contributor

CLAUDE.md looks good but lets please include instruction if not present causes Claude to make mistakes avoiding bloated claude.md file

@pmathew92

Copy link
Copy Markdown
Contributor Author

CLAUDE.md looks good but lets please include instruction if not present causes Claude to make mistakes avoiding bloated claude.md file
@NandanPrabhu Can you show some example on what exactly are you referring to ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants