- 
                Notifications
    
You must be signed in to change notification settings  - Fork 368
 
Add copilot-instructions.md for repository onboarding #616
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…arding Co-authored-by: krook <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot, there is a lot of duplication in this instruction set. Let's do a pass where we remove the duplication (unless this kind of duplication is important for you).
        
          
                .github/copilot-instructions.md
              
                Outdated
          
        
      | 
               | 
          ||
| **Total files per project**: Minimum 18 files (3 layouts × 3 colors × 2 formats) | ||
| 
               | 
          ||
| **Special cases**: Some projects like Kubernetes have additional variations (all-blue-color, white-text). | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot, there are also special cases where projects will have print versions of their logos in their folder path, but those aren't added to the example sheets.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added note about print versions to Special cases section. The document now mentions that some projects have print/ versions (like KEDA, SlimFaas) which may or may not be documented in examples/*.md. Commit: 38d905f
        
          
                .github/copilot-instructions.md
              
                Outdated
          
        
      | 
               | 
          ||
| ### 1. Prepare Artwork Files | ||
| 
               | 
          ||
| - Ensure all 18+ files exist (3 layouts × 3 colors × 2 formats) | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot, let's rephrase this.
| - Ensure all 18+ files exist (3 layouts × 3 colors × 2 formats) | |
| - Ensure the minimum number of files are present. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rephrased to "Ensure the minimum number of files are present (18+)" in the Adding New Project Artwork section. Commit: 38d905f
Co-authored-by: nate-double-u <[email protected]>
          
 Condensed the document from 309 to 102 lines (67% reduction) while preserving all essential information. Removed redundant explanations and consolidated sections. Commit: 38d905f  | 
    
Condensed the onboarding document from 309 to 102 lines (67% reduction) by:
Original prompt
This section details on the original issue you should resolve
<issue_title>Onboard this repository</issue_title>
<issue_description>Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
- Reduce the likelihood of a coding agent pull request getting rejected by the user due to generating code that fails the continuous integration build, fails a validation pipeline, or having misbehavior. - Minimize bash command and build failures. - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools. - Instructions must be no longer than 2 pages. - Instructions must not be task specific.Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
Add information about how to build and validate changes so the agent does not need to search and find it each time.
List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
- A description of the major architectural elements of the project, including the relative paths to the main project files, the location
 
- A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
 
- Document the steps so that the agent can replicate these itself.
 
- Any explicit validation steps that the agent can consider to have further confidence in its changes.
 
- Dependencies that aren't obvious from the layout or file structure.
 
- Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
 
- Perform a comprehensive inventory of the codebase. Search for and view: - README.md, CONTRIBUTING.md, and all other documentation files. - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc. - All scripts, particularly those pertaining to build and repo or environment setup. - All build and actions pipelines. - All project files. - All configuration and linting files. - For each file: - think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change? - If yes: - Document the command or information in detail. - Explicitly indicate which commands work and which do not and the order in which commands should be run. - Document any errors encountered as well as the steps taken to workaround them. - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bas...of configuration files for linting, compilation, testing, and preferences.
contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.