Skip to content

Add an AGENTS.md file to the project#12630

Open
QMalcolm wants to merge 6 commits intomainfrom
qmalcolm--add-agents-md-file
Open

Add an AGENTS.md file to the project#12630
QMalcolm wants to merge 6 commits intomainfrom
qmalcolm--add-agents-md-file

Conversation

@QMalcolm
Copy link
Contributor

We're seeing an increase in PRs overall, and a lot are either entirely or partially created using LLMs. Generally, I think that is a good thing. People having easier access to fix bugs and add features is cool. However, we need to balance that with stability and long term maintainability of the project. Some of the reoccurring issues we're seeing are things like:

  • Testing best practices specific to the project (generally one test per functional test class)
  • Commit hygiene (lack of this makes it harder to review)
  • New code ending up in the wrong area of the code base

Adding an AGENTS.md file should hopefully improve these types of problems. In turn this should allow us to review and ship the flood of PRs more easily maintaining stability and lessening the long-term maintainability burden.

We're seeing an increase PRs that were either entirely or partially
created using LLMs. Adding an AGENTS.md file should hopefully aid in
the quality of PRs submitted.
One common thing I've run up against when reviewing OSS Community PRs
is that the work tends to happen in one large commit, or as few large
commits. These large commits generally mix things like cleanup,
abstraction, bug fixes, feature adds, and refactors. Mixing these makes
it harder to review PRs. Asking the agent to follow commit disciple
should make it _easier_ to review PRs which in turn will help with
stability and long term maintainability.
Our testing setup for our functional tests means that multiple tests
in the same test class share the same underlying dbt project files.
This is unfortunate in that multiple tests in the same functional test
class can lead to flakiness is one test modifies the underlying dbt
project. Adding this context to the AGENTS.md should hopefully mean we
get fewer flaky tests moving forward.
@QMalcolm QMalcolm requested a review from a team as a code owner March 10, 2026 19:25
@cla-bot cla-bot bot added the cla:yes label Mar 10, 2026
@QMalcolm QMalcolm changed the title Add an AGENTS.md file to the proejct Add an AGENTS.md file to the project Mar 10, 2026
@codecov
Copy link

codecov bot commented Mar 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.40%. Comparing base (6bb1ea1) to head (4af8355).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #12630   +/-   ##
=======================================
  Coverage   91.40%   91.40%           
=======================================
  Files         203      203           
  Lines       25677    25677           
=======================================
  Hits        23470    23470           
  Misses       2207     2207           
Flag Coverage Δ
integration 88.25% <ø> (ø)
unit 65.36% <ø> (ø)

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

Components Coverage Δ
Unit Tests 65.36% <ø> (ø)
Integration Tests 88.25% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

MichelleArk
MichelleArk previously approved these changes Mar 10, 2026
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.

3 participants