Add GitHub Copilot instructions #529
Conversation
james-bruten-mo
left a comment
james-bruten-mo
left a comment
There was a problem hiding this comment.
Thanks Yash, this is a sensible addition. I'm a bit concerned that there's too much that isn't specifically copilot here so I suggest we remove some of the sections and just reference the ideas in the general section.
| requested | ||
| - Committing changes directly to `main` without review | ||
|
|
||
| ## Documentation Structure |
There was a problem hiding this comment.
I don't think this is required in this file
| Sphinx/reStructuredText conventions. | ||
| - For technical documentation, include code blocks, examples, and | ||
| cross-references where appropriate. | ||
| - Use Copilot Chat to: |
There was a problem hiding this comment.
Not sure these additional copilot points add anything more than what's in the General Guidelines above
| - Suggest improvements to existing docs | ||
| - Answer questions about Sphinx directives and configuration | ||
|
|
||
| ## Code of Conduct and Contribution |
There was a problem hiding this comment.
Not sure we need this section in this file. Maybe just mention the Contributing guidelines in the general section above
| - Request code or documentation examples as needed. | ||
| - Ask for explanations of Sphinx or reStructuredText features if unsure. | ||
|
|
||
| ## Coding Standards |
There was a problem hiding this comment.
As above I'm not sure we need a coding standards section here (although we might need a coding standards section for this repo - maybe in the readme?)
Maybe we a line in the general guidelines along the lines of "All AI generated code is still expected to follow the projects coding guidelines".
|
@james-bruten-mo - I should have clarified that these instructions are there to guide GitHub Copilot's behaviour across the repository not for humans. It allows us to define specific rules, coding standards, and project context that Copilot automatically incorporates into its reasoning for every chat request and code review (currently being investigated by users in other area). |
james-bruten-mo
left a comment
james-bruten-mo
left a comment
There was a problem hiding this comment.
Thanks for clarifying that Yash, happy for this to go on as is in that case
2 participants
Since this is a public repository, it makes sense to add some GitHub Copilot instructions for simulation-systems to guide contributors and Copilot.