AISTUFF Project

This project provides a complete automation and instruction system for GitHub Copilot, enabling maximum autonomy, best practices, and robust workflow management for any codebase. All instructions, scripts, and notes are designed to work together for seamless development, testing, and documentation.

Project Structure

• add_submodule.sh: Automates adding the Copilot instructions submodule to a target repo, including git flow and .gitignore setup.
• scaffold_project.sh: Sets up a new project with Copilot instructions, git flow, and submodule integration.
• instructions/: Contains all modular instruction files for Copilot, including:
  • general.instructions.md: Core principles, error handling, and workflow rules
  • best-practices.instructions.md: Coding standards and domain-specific rules
  • python.instructions.md, typescript.instructions.md, pascal.instructions.md: Language-specific standards
  • workflow.instructions.md, automation.instructions.md: Git flow, automation, and tool usage
  • CHANGELOG.md: Tracks all changes with date, time, and description
  • README.md: Directory-level documentation
• notes/: Reference documentation and usage examples for Copilot tools and automation
  • examples.md: How to use Copilot tools for code, docs, and workflow
  • tools.md: List and examples of all available Copilot tools
  • ai directives: Core automation rules for Copilot
• LICENSE: Project license

Key Features

• Maximum Copilot Autonomy: All instructions and scripts are designed for Copilot to act independently, gather context, and resolve issues without user intervention.
• Modular Instructions: Role-based and language-specific standards for any project type.
• Automated Git Flow: Scripts and instructions ensure proper branching, commits, and submodule management.
• Comprehensive Testing: Every feature and change must be tested and documented.
• Documentation First: All code, features, and changes are documented at a 3rd-grade reading level for clarity.
• Tool Integration: Full support for Copilot's internal tools (see notes/tools.md).

Usage

1. Use add_submodule.sh or scaffold_project.sh to set up Copilot instructions and git flow in your project.
2. Follow the modular instructions in instructions/ for coding, testing, and workflow standards.
3. Reference notes/ for examples, tool usage, and automation rules.
4. All changes must be tracked in instructions/CHANGELOG.md.

Getting Started

• Run scaffold_project.sh to initialize a new project with Copilot instructions and git flow.
• Use add_submodule.sh to add Copilot instructions to an existing repo.
• Review all instruction files in instructions/ before starting work.
• Use the notes for tool usage and automation examples.

Exclusions

• The .github directory is managed as a submodule and contains Copilot instructions for sharing across projects.
• The .vscode directory is for editor settings and is not part of the automation or instruction system.

License

See LICENSE for details.