skills.rest
ksopyla
ksopylaCOMMUNITY
Explore all skills by this author →
Website𝕏@ksopylaGitHub

engineering-change-tracking

Update CHANGELOG.md, active_todos.md, and git commit messages for Concept Encoder code changes.

Updated Jul 12, 2024
Search Tags:#git#changelog#project management#code review#documentation#traceability
One-click install
npx skills add https://github.com/ksopyla/MrCogito --skill engineering-change-tracking
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: engineering-change-tracking
Source: https://github.com/ksopyla/MrCogito/tree/main/.cursor/skills/engineering-change-tracking
Command: npx skills add https://github.com/ksopyla/MrCogito --skill engineering-change-tracking

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that significant code changes within the MrCogito project are properly documented and traceable, maintaining project integrity and historical context.

Core Features & Use Cases

  • Traceability: Links code modifications to project documentation, commit messages, and architectural milestones.
  • Consistency: Ensures CHANGELOG.md, active_todos.md, and commit messages are aligned after changes.
  • Use Case: After refactoring the core attention mechanism, use this skill to update the CHANGELOG.md, tag the architecture change, and ensure the commit message accurately reflects the refactor.

Quick Start

Use the engineering-change-tracking skill to document a recent refactor of the model's encoder.

Frequently Asked Questions about engineering-change-tracking

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

FAQPage Schema
How do I maintain project traceability for code changes across git and documentation?▼

Project traceability for code changes is maintained by aligning git commit messages with updates to CHANGELOG.md and active_todos.md, linking modifications to architectural milestones and historical context.

How do I update a changelog after refactoring code?▼

To update a changelog after a refactor, apply change tracking to update CHANGELOG.md, tag the architectural change, and ensure the git commit message accurately reflects the modifications made.

Why does my active_todos.md file fall out of sync with my git commit history?▼

Your active_todos.md falls out of sync when code modifications are committed without enforcing documentation alignment, requiring a tracking process to link refactors and bug fixes to project milestones.

What is the best way to document architecture updates for a codebase?▼

The best way to document architecture updates is to enforce consistency across CHANGELOG.md, active_todos.md, and commit messages, ensuring significant structural changes are properly recorded and traceable.

Does this change tracking approach work for minor script edits and bug fixes?▼

Yes, this change tracking approach applies to script edits and bug fixes, ensuring even minor modifications are documented in CHANGELOG.md and active_todos.md to maintain overall project integrity.

When do I need to enforce documentation alignment for code modifications?▼

You need to enforce documentation alignment for code modifications whenever you perform refactors, architecture updates, or bug fixes to ensure project integrity and preserve historical context.

Related Skills

Explore More Software Engineering Skills→
pradeepmoulipradeepmouli
2

speckit-workflows.baseline

Execute a script to generate baseline-spec.md and current-state.md from JSON output.

Community
Advanced
profmikegreeneprofmikegreene
1

stakeholder-notification

Notify stakeholders about pilot milestones, risks, and key decisions.

Community
Intermediate
korchasakorchasa
3

flow-commit

Automate commit planning and grouping into atomic Conventional Commits.

Community
Advanced
hopeoverturehopeoverture
6

docs-and-changelogs

Generate CHANGELOG.md entries from Conventional Commits and scaffold ADR and PRD templates.

Community
Advanced