skills.rest
ayubun
ayubunCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

maintaining-project-context

Update AGENTS.md files to reflect code contract and architectural changes.

8|1|Updated Feb 25, 2022
Search Tags:#code changes#project context#code documentation#AGENTS.md#contract maintenance
One-click install
npx skills add https://github.com/ayubun/dotfiles --skill maintaining-project-context-ayubun
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: maintaining-project-context
Source: https://github.com/ayubun/dotfiles/tree/main/configs/opencode/skills/ed3d-extending-opencode/maintaining-project-context
Command: npx skills add https://github.com/ayubun/dotfiles --skill maintaining-project-context-ayubun

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of identifying and updating AGENTS.md files to reflect changes in code contracts and architectural intent, ensuring documentation remains accurate and up-to-date.

Core Features & Use Cases

  • Change Detection: Identifies changes in code that affect contracts and documentation.
  • Update Coordination: Determines which AGENTS.md files need updating based on changes.
  • Verification: Verifies that the updated context files reflect the current codebase.
  • Use Case: When completing development phases or branches, this Skill automates the process of updating AGENTS.md files to ensure that documentation is current and accurate.

Quick Start

Run the maintaining-project-context skill to update AGENTS.md files after completing development phases.

Frequently Asked Questions about maintaining-project-context

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically update AGENTS.md files when code changes?▼

To update AGENTS.md files automatically, you can run a skill that diffs source code using git to detect contract changes and coordinates the necessary context file updates. This ensures your architecture documentation remains accurate.

What is the best way to keep project context documentation accurate after development?▼

Keeping project context documentation accurate requires identifying code changes that affect contracts and updating AGENTS.md files to reflect current architectural intent. Automating this verification process ensures your context files match the codebase.

Can I use git to detect which AGENTS.md files need updating?▼

Yes, you can use git to diff and analyze source code changes to determine which AGENTS.md files require updates. This change detection identifies modifications affecting contracts and coordinates the necessary documentation updates.

When do I need to update project context files for code documentation?▼

You need to update project context files when completing development phases or branches to ensure documentation is current. This process verifies that AGENTS.md files reflect the latest codebase contracts and architectural intent.

Do I need git to maintain AGENTS.md contract documentation?▼

Yes, git is required to diff and analyze source code for maintaining AGENTS.md contract documentation. The dependency allows the automated process to identify relevant code changes and determine which context files need updating.

Related Skills

Explore More Software Engineering Skills→
blakecyzeblakecyze
2

kanso-commit

Analyze the working tree and create atomic git commits with imperative messages.

Community
Intermediate
quan2005quan2005
13

docs-maintenance

Enforce documentation updates before commits when code changes alter architecture or behavior.

Community
Advanced
t-stringst-strings

Global Validation

Enforce centralized validation standards across repository code and CI pipelines.

Official
Basic
JsplixJsplix

code-review-pr-body

Generate structured pull request body drafts from git diffs.

Community
Intermediate