agentleFS
Anandb71Anandb71/arbor/.github/copilot-instructions.md

arbor

Copilot instructions160 starsChanged 10 months agoMITView on GitHub

- [ ] Scaffold the Project <!-- Ensure that the previous step has been marked as completed. Call project setup tool with projectType parameter. Run scaffolding command to create project files and folders. Use '.' as the working directory. If no appropriate projectType is available, search documentation using available tools. Otherwise, create the project structure manually using available file creation tools. --> - [ ] Customize the Project <!-- Verify that all previous steps have been completed successfully and you…

We split this copilot-instructions.md into the rules it gives an agent

38 rules. About 0 are common, 36 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈36

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Ensure that the previous step has been marked as completed.

    line 8
  2. Distinctive:

    Call project setup tool with projectType parameter.

    line 9
  3. Distinctive:

    Run scaffolding command to create project files and folders.

    line 10
  4. Distinctive:

    Use '.' as the working directory.

    line 11
  5. Distinctive:

    If no appropriate projectType is available, search documentation using available tools.

    line 12
  6. Distinctive:

    Verify that all previous steps have been completed successfully and you have marked the step as completed.

    line 18
  7. Distinctive:

    Verify that all previous steps have been completed.

    line 28
  8. Distinctive:

    Run diagnostics and resolve any issues.

    line 30
  9. Distinctive:

    Check for markdown files in project folder for relevant instructions on how to do this.

    line 31
  10. Very specific:

    Check https://code.visualstudio.com/docs/debugtest/tasks to determine if the project needs a task.

    line 37
  11. Distinctive:

    Verify that README.md and the copilot-instructions.md file in the .github directory exists and contains current project information.

    line 50
  12. Distinctive:

    If any tools are available to manage the above todo list, use it to track progress through this checklist.

    line 57
  13. Distinctive:

    After completing each step, mark it complete and add a summary.

    line 58
  14. Distinctive:

    Read current todo list status before starting each new step.

    line 59
  15. Distinctive:

    Avoid verbose explanations or printing full command outputs.

    line 62
  16. Distinctive:

    If a step is skipped, state that briefly (e.g.

    line 63
  17. Distinctive:

    Do not explain project structure unless asked.

    line 64
  18. Distinctive:

    Keep explanations concise and focused.

    line 65
  19. Distinctive:

    Use '.' as the working directory unless user specifies otherwise.

    line 68
  20. Distinctive:

    Avoid adding media or external links unless explicitly requested.

    line 69
  21. Distinctive:

    Use placeholders only with a note that they should be replaced.

    line 70
  22. Distinctive:

    Use VS Code API tool only for VS Code extension projects.

    line 71
  23. Distinctive:

    If the project setup information has additional rules, follow them strictly.

    line 73
  24. Distinctive:

    Always use the current directory as the project root.

    line 76
  25. Distinctive:

    If you are running any terminal commands, use the '.' argument to ensure that the current working directory is used ALWAYS.

    line 77
  26. Very specific:

    Do not create a new folder unless the user explicitly requests it besides a .vscode folder for a tasks.json file.

    line 78
  27. Distinctive:

    If any of the scaffolding commands mention that the folder name is not correct, let the user know to create a new folder with the correct …

    line 79
  28. Distinctive:

    Only install extension specified by the get_project_setup_info tool.

    line 82
  29. Distinctive:

    If the user has not specified project details, assume they want a "Hello World" project as a starting point.

    line 85
  30. Distinctive:

    Avoid adding links of any type (URLs, files, folders, etc.) or integrations that are not explicitly required.

    line 86
  31. Distinctive:

    Avoid generating images, videos, or any other media files unless explicitly requested.

    line 87
  32. Distinctive:

    If you need to use any media assets as placeholders, let the user know that these are placeholders and should be replaced with the actual …

    line 88
  33. Distinctive:

    Ensure all generated components serve a clear purpose within the user's requested workflow.

    line 89
  34. Distinctive:

    If a feature is assumed but not confirmed, prompt the user for clarification before including it.

    line 90
  35. Distinctive:

    If you are working on a VS Code extension, use the VS Code API tool with a query to find relevant VS Code API references and samples …

    line 91
  36. Distinctive:

    Before starting a new task in the above plan, update progress in the plan.

    line 100
  37. Distinctive:

    Keep communication concise and focused.

    line 103
  38. Distinctive:

    Follow development best practices.

    line 104

≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md
<!-- Use this file to provide workspace-specific custom instructions to Copilot. For more details, visit https://code.visualstudio.com/docs/copilot/copilot-customization#_use-a-githubcopilotinstructionsmd-file -->
  • Verify that the copilot-instructions.md file in the .github directory is created. (Created with checklist for Tauri Lattice setup)
  • Clarify Project Requirements (Tauri v2 + Rust backend + Svelte frontend for Lattice Personal OS with Arbor integration, MCP tools, system tray - from previous query; no ask needed)
  • Scaffold the Project <!-- Ensure that the previous step has been marked as completed. Call project setup tool with projectType parameter. Run scaffolding command to create project files and folders. Use '.' as the working directory. If no appropriate projectType is available, search documentation using available tools. Otherwise, create the project structure manually using available file creation tools. -->
  • Customize the Project <!-- Verify that all previous steps have been completed successfully and you have marked the step as completed. Develop a plan to modify codebase according to user requirements. Apply modifications using appropriate tools and user-provided references. Skip this step for "Hello World" projects. -->
  • Install Required Extensions (None specified by get_project_setup_info for 'other'; skipped)
  • Compile the Project <!-- Verify that all previous steps have been completed. Install any missing dependencies. Run diagnostics and resolve any issues. Check for markdown files in project folder for relevant instructions on how to do this. -->
  • Create and Run Task <!-- Verify that all previous steps have been completed. Check https://code.visualstudio.com/docs/debugtest/tasks to determine if the project needs a task. If so, use the create_and_run_task to create and launch a task based on package.json, README.md, and project structure. Skip this step otherwise. -->
  • Launch the Project <!-- Verify that all previous steps have been completed. Prompt user for debug mode, launch only if confirmed. -->
  • Ensure Documentation is Complete <!-- Verify that all previous steps have been completed. Verify that README.md and the copilot-instructions.md file in the .github directory exists and contains current project information. Clean up the copilot-instructions.md file in the .github directory by removing all HTML comments. -->
<!-- ## Execution Guidelines PROGRESS TRACKING: - If any tools are available to manage the above todo list, use it to track progress through this checklist. - After completing each step, mark it complete and add a summary. - Read current todo list status before starting each new step. COMMUNICATION RULES: - Avoid verbose explanations or printing full command outputs. - If a step is skipped, state that briefly (e.g. "No extensions needed"). - Do not explain project structure unless asked. - Keep explanations concise and focused. DEVELOPMENT RULES: - Use '.' as the working directory unless user specifies otherwise. - Avoid adding media or external links unless explicitly requested. - Use placeholders only with a note that they should be replaced. - Use VS Code API tool only for VS Code extension projects. - Once the project is created, it is already opened in Visual Studio Code—do not suggest commands to open this project in Visual Studio again. - If the project setup information has additional rules, follow them strictly. FOLDER CREATION RULES: - Always use the current directory as the project root. - If you are running any terminal commands, use the '.' argument to ensure that the current working directory is used ALWAYS. - Do not create a new folder unless the user explicitly requests it besides a .vscode folder for a tasks.json file. - If any of the scaffolding commands mention that the folder name is not correct, let the user know to create a new folder with the correct name and then reopen it again in vscode. EXTENSION INSTALLATION RULES: - Only install extension specified by the get_project_setup_info tool. DO NOT INSTALL any other extensions. PROJECT CONTENT RULES: - If the user has not specified project details, assume they want a "Hello World" project as a starting point. - Avoid adding links of any type (URLs, files, folders, etc.) or integrations that are not explicitly required. - Avoid generating images, videos, or any other media files unless explicitly requested. - If you need to use any media assets as placeholders, let the user know that these are placeholders and should be replaced with the actual assets later. - Ensure all generated components serve a clear purpose within the user's requested workflow. - If a feature is assumed but not confirmed, prompt the user for clarification before including it. - If you are working on a VS Code extension, use the VS Code API tool with a query to find relevant VS Code API references and samples related to that query. TASK COMPLETION RULES: - Your task is complete when: - Project is successfully scaffolded and compiled without errors - copilot-instructions.md file in the .github directory exists in the project - README.md file exists and is up to date - User is provided with clear instructions to debug/launch the project Before starting a new task in the above plan, update progress in the plan. -->
  • Work through each checklist item systematically.
  • Keep communication concise and focused.
  • Follow development best practices.

Download now (ZIP)

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository2 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.