GoProX icon indicating copy to clipboard operation
GoProX copied to clipboard

Enhancement: AI Instructions Tracking and Evolution

Open fxstein opened this issue 8 months ago • 0 comments

Summary

This issue serves as a central placeholder for tracking, discussing, and evolving the AI instructions that govern project automation, standards enforcement, and assistant behavior in the GoProX project.

Requirements

  • Maintain a single, up-to-date source for all AI instructions relevant to the project.
  • Document all current instructions and their rationale.
  • Provide a space for proposing, discussing, and reviewing future instructions.
  • Ensure all contributors and AI assistants reference this issue for the latest guidance.

Motivation

As the GoProX project evolves, so do the requirements for automation, release management, and project standards. Having a single, well-maintained issue for AI instructions ensures consistency, transparency, and ease of onboarding for new contributors and AI systems.

Current AI Instructions

The following instructions have already been created and are enforced:

  • Release Workflow Automation:
    • When a release is requested, the assistant must:
      1. Run the version bump script with .
      2. Run the release script with .
      3. Start the release monitor for the specific release version.
  • Project Standards:
    • All code, documentation, and communication must follow the rules in .
    • Use zsh code blocks for shell script examples.
    • Use the correct issue reference format: (refs #n) or (refs #n #n ...).
    • All transient output must go in the directory (never committed).
    • Documentation must be updated for all script/workflow changes.
    • YAML and shell scripts must pass linting before commit suggestions.
    • Communication must be concise, direct, and free of conversational padding.

Placeholder for Future Instructions

  • Use this issue to propose, discuss, and document new AI instructions as project needs evolve.
  • All new instructions should be added to and referenced here.
  • This issue will remain open as a living document for ongoing improvements.

Acceptance Criteria

  • This issue is referenced in and project documentation.
  • All current and future AI instructions are tracked here.
  • Contributors and AI assistants are aware of and follow the latest instructions.

Reference

  • AI_INSTRUCTIONS.md
  • README.md

fxstein avatar Jun 22 '25 14:06 fxstein