Skip to content

Add agent docs - #376

Open
lameze wants to merge 1 commit into
mainfrom
AgentDocs
Open

Add agent docs#376
lameze wants to merge 1 commit into
mainfrom
AgentDocs

Conversation

@lameze

@lameze lameze commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@codecov-commenter

codecov-commenter commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 23.01%. Comparing base (56ae775) to head (e69fe8c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #376   +/-   ##
=======================================
  Coverage   23.01%   23.01%           
=======================================
  Files          72       72           
  Lines        3289     3289           
=======================================
  Hits          757      757           
  Misses       2532     2532           
Flag Coverage Δ
check_upgrade_savepoints 0.45% <ø> (ø)
checkstyle_manipulations 0.00% <ø> (ø)
compare_databases 2.34% <ø> (ø)
continuous_manage_queues_validation 1.36% <ø> (ø)
define_excluded 1.09% <ø> (ø)
detect_conflicts 1.45% <ø> (ø)
diff_extract_changes 0.00% <ø> (ø)
grunt_process 2.94% <ø> (ø)
illegal_whitespace 2.58% <ø> (ø)
list_valid_components 0.00% <ø> (ø)
mustache_lint 2.79% <ø> (ø)
mustache_lint_plugins 1.30% <ø> (ø)
php_lint 1.21% <ø> (ø)
remote_branch_reporter 0.00% <ø> (ø)
setup 0.00% <ø> (ø)
thirdparty_check 1.55% <ø> (ø)
travis-branch-checker 0.00% <ø> (ø)
upgrade_external_backup 1.61% <ø> (ø)
verifications 0.00% <ø> (ø)
verify_commit_messages 2.58% <ø> (ø)
versions_check_set 5.10% <ø> (ø)

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

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

Document how this repository actually works, for both new contributors and
AI agents:

- AGENTS.md: what the repo is, the conventions every script follows
  (env-var configuration, the `required` guard, `set -e`, locating siblings
  by relative path), the testing workflow, and a safety section covering the
  scripts that perform destructive git operations or mutate the live tracker.
- docs/scripts.md: catalogue of every script - purpose, family, whether it
  is destructive, and which bats suite covers it.
- docs/testing.md: how the bats suites, helpers and fixtures work, how to run
  them locally, and how CI runs them.
- README.md: rewritten from a stub into a real overview.
- tracker_automations/README.md: the shared jira.sh contract and the common
  variables all the tracker jobs use.

Environment variables are deliberately documented in one place only: the
comment block at the top of each script, next to the code it describes.
16 shell scripts had no purpose line at all, just a variable list, so add
one to each of those headers.

Also add /.ai/ to .gitignore, alongside /.idea/, so local AI tooling config
cannot be committed by accident.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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