copilot-instructions
v1.0.1
Published
Generate .github/copilot-instructions.md and update .gitignore
Downloads
13
Maintainers
Readme
Copilot Instructions Generator
This project generates a .github/copilot-instructions.md file and updates the .gitignore file to include it. The purpose is to provide detailed instructions for GitHub Copilot.
Installation
To install the project, run:
npm installUsage
To generate the copilot-instructions.md file and update the .gitignore, run the following command:
npx copilot-instructionsHow It Works
- Create Directory: The script creates the
.githubdirectory if it doesn't already exist. - Generate Instructions File: It generates the
copilot-instructions.mdfile with a template if the file doesn't already exist. - Update .gitignore: It adds the
copilot-instructions.mdfile to the.gitignoreto ensure it is not tracked by Git.
Author
Akshay Malik
License
This project is licensed under the MIT License.
