chore: add initial Copilot instructions file TDE-1663#1279
chore: add initial Copilot instructions file TDE-1663#1279paulfouquet wants to merge 1 commit intomasterfrom
Conversation
paulfouquet
requested review from
MDavidson17,
amfage,
blacha,
ccbblin and
schmidtnz
|
|
||
| ## Copilot Usage | ||
|
|
||
| - When asking Copilot for code, specify: |
There was a problem hiding this comment.
An example could be good here.
| - Example commit: `fix(tileindex-validate): log source file on geo transform error` | ||
| - Example branch: `fix/log-tiff-source-on-geo-transform-error-tde-1677` | ||
|
|
||
| ## Copilot Usage |
There was a problem hiding this comment.
this file is for copilot, not for us devs, so shouldn't contain instructions for us how to use copilot?
There was a problem hiding this comment.
Yeah I was thinking that an example would be good but as you say maybe this section shouldn't be here at all.
| ## Testing | ||
|
|
||
| - Use the `node:test` framework and `assert` for assertions. | ||
| - When generating tests, add them to the existing test file for the relevant module. |
There was a problem hiding this comment.
Overall, we may need to be more succinct for this to be an effective prompt?
| - When generating tests, add them to the existing test file for the relevant module. | |
| - One test file for each module. |
(Is module the correct term here?)
| - Use the `node:test` framework and `assert` for assertions. | ||
| - When generating tests, add them to the existing test file for the relevant module. | ||
| - Use a new describe block if the function being tested does not already have one. | ||
| - Follow existing conventions for test names, structure, and assertions. |
There was a problem hiding this comment.
Should we instead ask to align with existing conventions and harmonize/implement best practice where existing code deviates?
| @@ -0,0 +1,45 @@ | |||
| # GitHub Copilot Project Instructions | |||
|
|
|||
| This file provides guidelines and instructions for using GitHub Copilot in this project. Amend and maintain this file as needed to help Copilot generate code and documentation that matches this project's standards and requirements. | |||
There was a problem hiding this comment.
is this from a sample file? Might need to be removed
3 participants
Motivation
Improving productivity using AI by giving more detailed and project-specific instructions to Copilot. The goal is to minimise the refinement the developer has to do with Copilot to get generated code or answers to questions.
Modifications
Verification
#1277 & #1278