Skip to content

feat: add AGENTS.md for Claude Code etc.#3120

Open
bradenmacdonald wants to merge 2 commits into
openedx:masterfrom
open-craft:braden/agents.md
Open

feat: add AGENTS.md for Claude Code etc.#3120
bradenmacdonald wants to merge 2 commits into
openedx:masterfrom
open-craft:braden/agents.md

Conversation

@bradenmacdonald

@bradenmacdonald bradenmacdonald commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Description

This adds an AGENTS.md file that Claude Code and other AI coding tools will read, to help save time by ensuring that the agents are aware of our current best practices for this repo.

Impacts: developers

Supporting information

Discussed on Slack: https://openedx.slack.com/archives/C04BM6YC7A6/p1774912475830039

Private ref: MNG-4670

@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 30, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Jun 30, 2026
@codecov

codecov Bot commented Jun 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.69%. Comparing base (8d5842b) to head (b921343).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3120      +/-   ##
==========================================
+ Coverage   95.66%   95.69%   +0.03%     
==========================================
  Files        1402     1400       -2     
  Lines       33224    33372     +148     
  Branches     7529     7809     +280     
==========================================
+ Hits        31783    31937     +154     
+ Misses       1394     1373      -21     
- Partials       47       62      +15     

☔ View full report in Codecov by Harness.
📢 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.

Comment thread AGENTS.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants