Skip to content

Conversation

ykdojo
Copy link
Contributor

@ykdojo ykdojo commented Sep 8, 2025

Changes Made

  • Add PR conventions note to AGENTS.md
  • Add CLAUDE.md symlink to AGENTS.md

Related Issues

Checklist

  • Documentation builds and is formatted properly (tag @/ccmao1130 for docs review)

@github-actions github-actions bot added the docs label Sep 8, 2025
@ykdojo ykdojo marked this pull request as ready for review September 8, 2025 23:49
@ykdojo ykdojo requested a review from srilman September 8, 2025 23:49
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR adds documentation for PR conventions to the AGENTS.md file and creates a CLAUDE.md symlink to improve AI agent compatibility. The changes are focused on helping AI coding assistants understand the repository's contribution standards.

The main change adds a "PR Conventions" section to AGENTS.md that specifies two key requirements: PR titles must follow Conventional Commits format (e.g., feat: ...) and are enforced by .github/workflows/pr-labeller.yml, and PR descriptions should follow the template in .github/pull_request_template.md. This documentation follows the emerging agents.md standard for providing concise development instructions to AI agents.

Additionally, a CLAUDE.md symlink is created that points to AGENTS.md. This addresses compatibility with Claude Code, which doesn't yet support the AGENTS.md standard but can read CLAUDE.md files. The symlink approach maintains a single source of truth while ensuring broader AI agent compatibility.

These changes integrate well with the existing codebase infrastructure - they reference actual workflow files and templates that already exist in the repository, providing actionable guidance that's tied to enforced automation. The AGENTS.md file was already present in the repository (as shown in the file listing) and serves as documentation specifically for AI development tools working with the Daft framework.

Confidence score: 5/5

  • This PR is safe to merge with minimal risk
  • Score reflects simple documentation-only changes with no functional code modifications
  • No files require special attention

2 files reviewed, no comments

Edit Code Review Bot Settings | Greptile

@ykdojo ykdojo changed the title docs: add PR conventions note to AGENTS.md chore: add PR conventions note to AGENTS.md Sep 8, 2025
@github-actions github-actions bot added chore and removed docs labels Sep 8, 2025
Copy link

codecov bot commented Sep 9, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.28%. Comparing base (feffe55) to head (a90b4f2).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5166      +/-   ##
==========================================
+ Coverage   73.87%   74.28%   +0.40%     
==========================================
  Files         957      957              
  Lines      124146   123191     -955     
==========================================
- Hits        91717    91507     -210     
+ Misses      32429    31684     -745     

see 26 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ykdojo ykdojo merged commit 889a3dd into main Sep 9, 2025
100 of 104 checks passed
@ykdojo ykdojo deleted the edit-documentation branch September 9, 2025 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants