Add comprehensive AI assistant guidelines and ADR management system #1259
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.
Changes
This PR adds comprehensive AI assistant guidelines and tooling for the cardano-cli project:
.github/copilot-instructions.md- Complete AI coding assistant guidelines (197 lines)scripts/wiki-update- Automated ADR documentation management script (52 lines).gitignore- Added exclusions for.ai-scratch/anddocs/mirror/directoriesChangelog
Context
This PR introduces a comprehensive framework for AI coding assistants working on the cardano-cli project. The goal is to provide AI assistants with detailed architectural guidance, development patterns, and best practices specific to this codebase.
The framework includes:
This addresses the need for AI assistants to understand cardano-cli's unique architectural patterns, especially the era-based command system and the project's formal decision-making process through ADRs.
How to trust this PR
Key files to review:
.github/copilot-instructions.md- The main AI guidelines document covering:scripts/wiki-update- ADR management automation that:docs/mirror/cardano-node-wikidocs/mirror/dates/cardano-node-wiki.gitignore- Excludes new directories:.ai-scratch/for temporary AI-generated files (commit messages, analysis outputs)docs/mirror/for local documentation mirrorsTesting the wiki-update script:
Verifying AI guidelines:
The guidelines reference concrete project patterns and can be validated by checking:
cardano-cli/test/cardano-cli-golden/files/golden/help/src/Cardano/CLI/EraBased/Checklist