Skip to content

Add AGENTS.md with AI coding agent guidelines#4102

Merged
imnasnainaec merged 11 commits into
masterfrom
copilot/create-agents-md-file
May 8, 2026
Merged

Add AGENTS.md with AI coding agent guidelines#4102
imnasnainaec merged 11 commits into
masterfrom
copilot/create-agents-md-file

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 16, 2026

Devin: https://app.devin.ai/review/sillsdev/TheCombine/pull/4102

Provides structured guidelines for AI coding agents working on The Combine codebase, covering workflow requirements, formatting conventions, and integration points.

Original prompt

This section details on the original issue you should resolve

<issue_title>Create an AGENTS.md file</issue_title>
<issue_description>Some things to include (divided into appropriate sections):

  • commit messages should satisfy the defaults of gitlint
  • follow style guides in docs/style_guide/
  • npm run fmt-backend after any backend changes
  • npm run fmt-frontend after any frontend changes
  • npm run license-report-backend after any backend dependency changes
  • npm run license-report-frontend after any frontend dependency changes
  • in React, alphabetize component props
  • when there are changes in Backend/Controllers/, set up a venv per README instructions (https://github.com/sillsdev/TheCombine?tab=readme-ov-file#python), then with the backend running (npm run backend) do python ./scripts/generate_openapi.py
  • don't translate any strings added to public/locales/en/translation.json; localization is handled externally in Crowdin</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Added comprehensive contribution & agent guidelines covering commit standards, code/style conventions for frontend and backend, formatting workflows, dependency/install steps, OpenAPI regeneration, and license-report requirements.
    • Clarified localization and subtitle handling (English-only edits, Crowdin-managed translations) and added a "Component Props" rule for TypeScript React props ordering with examples and rationale.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 16, 2026

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 925ec818-ed8f-4acf-b423-3ee813732189

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR introduces two documentation updates: a new AGENTS.md file with guidelines for commit messages, code formatting, dependency management, OpenAPI spec regeneration, and localization; and an expanded TypeScript style guide with a new "Component Props" section prescribing alphabetized prop ordering.

Changes

Cohort / File(s) Summary
Agent Guidelines
AGENTS.md
New documentation file establishing standards for commit messages (gitlint compliance), code style enforcement (formatting, linting), dependency management workflows, OpenAPI spec regeneration procedures after backend changes, and localization practices.
TypeScript Style Guide Expansion
docs/style_guide/ts_style_guide.md
Added new "Component Props" section under Components requiring alphabetization of React component props. Includes Good/Bad examples demonstrating proper ordering in interface/type definitions, prop destructuring, and JSX usage.

Possibly related issues

  • Create an AGENTS.md file #3969 — This PR directly implements the AGENTS.md file requirements and adds the React prop alphabetization guidance specified in the issue.

Poem

🐰 New guidelines hopped into view,
Props alphabetized, clean and true,
Agents united by style so bright,
Documentation guides code just right! ✨


Estimated code review effort: 🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change—adding an AGENTS.md file with AI coding agent guidelines—and is clear and concise.
Linked Issues check ✅ Passed The PR implements all coding requirements from issue #3969: gitlint compliance, style guide references, formatting commands, dependency management, OpenAPI generation workflow, localization rules, and alphabetizing React component props.
Out of Scope Changes check ✅ Passed The PR includes only in-scope changes: AGENTS.md documentation and the addition of Component Props guidance to ts_style_guide.md, both directly aligned with issue #3969 requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ 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 copilot/create-agents-md-file

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

Copilot AI changed the title [WIP] Create AGENTS.md file with development guidelines Add AGENTS.md with AI coding agent guidelines Jan 16, 2026
Copilot AI requested a review from imnasnainaec January 16, 2026 17:50
imnasnainaec

This comment was marked as resolved.

@imnasnainaec

This comment was marked as resolved.

@coderabbitai

This comment was marked as outdated.

coderabbitai[bot]

This comment was marked as resolved.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for AI coding agents working on The Combine codebase. It creates a new AGENTS.md file with structured guidelines and updates the TypeScript style guide to include component props alphabetization conventions.

Changes:

  • Added AGENTS.md with workflow requirements covering commit messages, code style, formatting, dependency management, OpenAPI generation, and localization
  • Enhanced docs/style_guide/ts_style_guide.md with a new "Component Props" subsection documenting the convention to alphabetize React component props

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
AGENTS.md New comprehensive guide for AI coding agents with workflow requirements, formatting conventions, and integration points including gitlint compliance, style guide references, npm scripts usage, and OpenAPI/localization workflows
docs/style_guide/ts_style_guide.md Added "Component Props" subsection to the table of contents and documented alphabetization convention for React component props with examples and rationale

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md Outdated
@github-actions github-actions Bot added documentation Improvements or additions to documentation backend frontend labels May 4, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.94%. Comparing base (f1d68a6) to head (52adee4).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4102   +/-   ##
=======================================
  Coverage   75.94%   75.94%           
=======================================
  Files         303      303           
  Lines       11352    11352           
  Branches     1403     1403           
=======================================
  Hits         8621     8621           
  Misses       2330     2330           
  Partials      401      401           
Flag Coverage Δ
backend 87.23% <ø> (ø)
frontend 66.79% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 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.

Copilot AI and others added 8 commits May 4, 2026 15:15
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
@imnasnainaec imnasnainaec force-pushed the copilot/create-agents-md-file branch from cb053f7 to ecdcd05 Compare May 4, 2026 19:15
@github-actions github-actions Bot added the test label May 4, 2026
@imnasnainaec

This comment was marked as resolved.

@imnasnainaec imnasnainaec marked this pull request as ready for review May 4, 2026 19:34
@imnasnainaec imnasnainaec added the 🟨Medium Medium-priority PR label May 4, 2026
@coderabbitai

This comment was marked as outdated.

@jasonleenaylor
Copy link
Copy Markdown
Contributor

Backend.Tests/AGENTS.md line 8 at r3 (raw file):

  - Use type inference (`var`) wherever possible
  - Add braces to one-line `if` statements
  - Prefer `Range` for simple loop iteration

I think pulling this up one level for this and the Backend folder is a good idea.

@jasonleenaylor
Copy link
Copy Markdown
Contributor

src/AGENTS.md line 11 at r4 (raw file):

- Refer to [`docs/style_guide/ts_style_guide.md`](../docs/style_guide/ts_style_guide.md) for comprehensive TypeScript
  and JavaScript conventions
- Key points include:

Pull this out to avoid a maintenance consistency issue in the future.

Copy link
Copy Markdown
Contributor

@jasonleenaylor jasonleenaylor left a comment

Choose a reason for hiding this comment

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

:LGTM: after the suggestion

@jasonleenaylor reviewed 10 files and all commit messages, and made 1 comment.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on imnasnainaec).

@imnasnainaec imnasnainaec merged commit cd61fec into master May 8, 2026
19 of 20 checks passed
@imnasnainaec imnasnainaec deleted the copilot/create-agents-md-file branch May 8, 2026 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend documentation Improvements or additions to documentation frontend 🟨Medium Medium-priority PR test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create an AGENTS.md file

4 participants