Create copilot-instructions.md with guidelines #194
Conversation
Added guidelines for development practices, git operations, external resources, communication style, change logging, and coding agent.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces Copilot instructions to standardize development practices and AI assistant behavior. The guidelines establish conventions for minimal implementations, git operations, external resource usage, communication style, change logging, and coding agent behaviors.
Key Changes:
- Added development practices favoring lean, proof-of-concept implementations
- Defined git operations and external resource handling conventions
- Established communication style guidelines emphasizing clarity and objectiveness
| - Avoid `if __name__ == "__main__"` patterns in package code, unless asked | ||
| For example, rather than using: |
There was a problem hiding this comment.
[nitpick] The guideline states 'in package code' but the context of when this pattern should be avoided versus allowed is unclear. Consider clarifying whether this applies to all Python files in the repository or specifically to library/package modules (as opposed to standalone scripts or entry points).
| - Avoid `if __name__ == "__main__"` patterns in package code, unless asked | |
| For example, rather than using: | |
| - Avoid `if __name__ == "__main__"` patterns in files intended to be imported as modules (i.e., package/library code), unless asked. This pattern is acceptable in standalone scripts or entry points. | |
| For example, in package/library modules, rather than using: |
|
|
||
| - Validate and access link content using your available MCP tools (Playwright and/or Perplexity) | ||
| - Search GitHub for relevant open-source alternatives to commercial tools | ||
| - Prioritize official package documentation over inferred usage by using your Context7 MCP tool |
There was a problem hiding this comment.
[nitpick] References to 'your' MCP tools assume the reader is an AI assistant. Since this is a guidelines document that may be read by human developers, consider rephrasing to be more neutral (e.g., 'Validate and access link content using available MCP tools' or add a note that this section is specifically for AI assistants).
| - Prioritize official package documentation over inferred usage by using your Context7 MCP tool | |
| - Prioritize official package documentation over inferred usage by using available Context7 MCP tools |
|
|
||
| - Set environment variables `PIP_TIMEOUT=600` and `PIP_RETRIES=2` prior to `conda` or `pip` installs | ||
| - Include plots directly in your comment reply via ``. Truncate the commit hash to the first 7 characters only. For example, `https://github.com/AccelerationConsortium/evaluation-metrics/blob/52754e7/scripts/bo_benchmarks/demonstrations/branin_campaign_demonstration_results.png?raw=true`. For provenance, ensure you use the shortened (7-character) commit hash, not the branch name | ||
| - If you mention files in your comment reply, add direct hyperlinks based on the shortened (7-character) commit hash |
There was a problem hiding this comment.
This guideline is incomplete. It doesn't specify the format or pattern for these hyperlinks (e.g., should they follow the same pattern as line 60 with https://github.com/<user/org>/<repo>/blob/<hash>/<filepath>?). Consider adding an example or referencing the format from the previous guideline.
| - If you mention files in your comment reply, add direct hyperlinks based on the shortened (7-character) commit hash | |
| - If you mention files in your comment reply, add direct hyperlinks using the format `https://github.com/<user/org>/<repo>/blob/<shortened-commit-hash>/<filepath>`, with the commit hash truncated to 7 characters. For example, `https://github.com/AccelerationConsortium/evaluation-metrics/blob/52754e7/scripts/bo_benchmarks/demonstrations/branin_campaign_demonstration_results.png?raw=true`. Use the same pattern as for plots in the previous guideline. |
Added guidelines for development practices, git operations, external resources, communication style, change logging, and coding agent.