copilot-instructions

1.0.1 • Public • Published

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 install

Usage

To generate the copilot-instructions.md file and update the .gitignore, run the following command:

npx copilot-instructions

How It Works

  1. Create Directory: The script creates the .github directory if it doesn't already exist.
  2. Generate Instructions File: It generates the copilot-instructions.md file with a template if the file doesn't already exist.
  3. Update .gitignore: It adds the copilot-instructions.md file to the .gitignore to ensure it is not tracked by Git.

Author

Akshay Malik

License

This project is licensed under the MIT License.

Package Sidebar

Install

npm i copilot-instructions

Weekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

3.41 kB

Total Files

3

Last publish

Collaborators

  • akshaymalik1995