docs: establish AGENTS.md as canonical agent instruction file#110
Merged
Conversation
AGENTS.md becomes the single source of truth for agent guidance. Both CLAUDE.md and .github/copilot-instructions.md are now symlinks pointing to it, eliminating duplicated maintenance. Content is slimmed to a standards overview: shell compatibility, code style, Markdown rules, and a pre-PR checklist. Detailed procedural content (test patterns, commit format tables, linting commands, security checklists) is deferred to the six skills in .claude/skills/, which are loaded automatically by Claude Code, GitHub Copilot, and any agent implementing the open Agent Skills standard. Also fixes a stale inaccuracy: the previous file listed 'refactor' as triggering no version bump; the writing-commits skill (now the source of truth) correctly documents it as a patch bump. https://claude.ai/code/session_01BwkVcHyk7eJKBDWgyUdnhJ
Contributor
There was a problem hiding this comment.
Pull request overview
Establishes AGENTS.md as the canonical, slimmed-down agent guidance document for the bash-logger repo, delegating detailed procedures to the .claude/skills/* documents.
Changes:
- Adds
AGENTS.mdwith links to the six skills and a standards overview (linting, tests, commits, shell compatibility, Markdown rules, code style). - Documents Conventional Commits / semantic-release expectations and a pre-PR checklist for agents.
| * Use POSIX-compatible syntax whenever possible | ||
| * Use `[ ]` instead of `[[ ]]` for maximum compatibility | ||
| * Use `$(...)` instead of backticks (works everywhere) | ||
| * Use `.` or `source` for sourcing files (both POSIX) |
Comment on lines
+107
to
+108
| * **MD060** — table separators: `| --- | --- |` with spaces, never `|---|---|` | ||
|
|
Comment on lines
+74
to
+85
| * Use POSIX-compatible syntax whenever possible | ||
| * Use `[ ]` instead of `[[ ]]` for maximum compatibility | ||
| * Use `$(...)` instead of backticks (works everywhere) | ||
| * Use `.` or `source` for sourcing files (both POSIX) | ||
| * Avoid bash-specific features like arrays and associative arrays unless necessary | ||
| * Document shell requirements in comments | ||
|
|
||
| **DON'T:** | ||
|
|
||
| * Use bash-only features like `[[ ]]`, `(( ))`, or `=~` unless necessary | ||
| * Use bash arrays or associative arrays unless truly needed | ||
| * Rely on bash-specific string manipulation |
Owner
Author
|
@copilot apply changes based on the comments in this thread |
… sections Agent-Logs-Url: https://github.com/GingerGraham/bash-logger/sessions/65fbeb91-beb2-4f32-ab7f-a436f1a8035f Co-authored-by: GingerGraham <34165628+GingerGraham@users.noreply.github.com>
Contributor
Applied all three changes in commit 6046fe5:
|
Owner
Author
|
🎉 This PR is included in version 2.5.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AGENTS.md becomes the single source of truth for agent guidance. Both CLAUDE.md and .github/copilot-instructions.md are now symlinks pointing to it, eliminating duplicated maintenance.
Content is slimmed to a standards overview: shell compatibility, code style, Markdown rules, and a pre-PR checklist. Detailed procedural content (test patterns, commit format tables, linting commands, security checklists) is deferred to the six skills in .claude/skills/, which are loaded automatically by Claude Code, GitHub Copilot, and any agent implementing the open Agent Skills standard.
Also fixes a stale inaccuracy: the previous file listed 'refactor' as triggering no version bump; the writing-commits skill (now the source of truth) correctly documents it as a patch bump.
https://claude.ai/code/session_01BwkVcHyk7eJKBDWgyUdnhJ