NH-125037: add copilot instructions#237
Conversation
| Whenever you are provided with Jira issue key in following format "<key>-XXXXX" or "https://swicloud.atlassian.net/browse/<key>-XXXXX", the first thing you should do is to use `jira_` tools (if provided) to read the Jira issue description and if needed related Jira issues, comments or confluence documents, and take its context into account when answering the question. | ||
| If you are not provided with `jira_` tools, just mention that you cannot access Jira issues and provide a general answer based on your knowledge. | ||
|
|
||
| <!-- the source of this file is https://github.com/solarwinds-sandbox/copilot/blob/main/.github/instructions/jira.instructions.md --> No newline at end of file |
There was a problem hiding this comment.
Is this file needed, meaning are you actually integrating copilot with jira_ tools and if so, what does that require and the security implications?
| - **Formatting**: Ensure that the content is properly formatted and structured according to the guidelines. | ||
| - **Validation**: Run the validation tools to check for compliance with the rules and guidelines. | ||
|
|
||
| <!-- the source of this file is https://github.com/solarwinds-sandbox/copilot/blob/main/.github/instructions/markdown.instructions.md --> No newline at end of file |
There was a problem hiding this comment.
Another question on whether this file is needed since there are already a few CI actions for markdown.
| - Test compatibility with minimum supported Ruby version | ||
| - Document any version-specific behavior | ||
|
|
||
| <!-- the source of this file is based on codebase analysis of solarwinds/apm-ruby --> |
There was a problem hiding this comment.
This instruction file seems useful!
| 4. **Architectural Consistency**: Maintain the modular architecture with clear separation between API, config, sampling, and instrumentation layers | ||
| 5. **Code Quality**: Prioritize maintainability, performance, and security in all generated code | ||
|
|
||
| ## Technology Version Detection |
There was a problem hiding this comment.
Should there be links to upstream OTel repos somewhere in this file?
| @@ -0,0 +1,358 @@ | |||
| # AGENTS.md | |||
|
|
|||
| ## Project Overview | |||
There was a problem hiding this comment.
Same question about maybe adding links to upstream repos.
Also, big chunks of this file seem duplicate of CONTRIBUTING.md. How about DRYing and just refer to that instead?
There was a problem hiding this comment.
Referenced some the section to CONTRIBUTING.md and added the link
2 participants
Description
Test (if applicable)