Add GitHub Copilot instructions for repository context #580
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: hombit <1784493+hombit@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Configure instructions for Copilot coding agent
Add GitHub Copilot instructions for repository context
Nov 14, 2025
hombit
requested changes
Nov 14, 2025
.github/copilot-instructions.md
Outdated
Comment on lines
41
to
42
| - System dependencies: `libgsl-dev` (on Ubuntu/Debian) | ||
| - Optional: CMake and C++ compiler for Ceres solver support |
Contributor
Author
There was a problem hiding this comment.
Added FFTW to system dependencies in commit 030d7a4.
.github/copilot-instructions.md
Outdated
| #### Running Tests | ||
| - **All tests**: `pytest` or `python -m pytest` | ||
| - **With benchmarks**: `pytest --benchmark-enable` | ||
| - **Exclude slow benchmarks**: `pytest -m "not (nobs or multi)" --benchmark-enable` |
Contributor
Author
There was a problem hiding this comment.
Updated to "(recommended)" in commit 030d7a4.
.github/copilot-instructions.md
Outdated
| - **Specific test file**: `pytest tests/test_w_bench.py` | ||
|
|
||
| #### Linting and Formatting | ||
| - **Python**: `black` and `ruff` (configured in pyproject.toml) |
Member
There was a problem hiding this comment.
Black is going to be replaced with ruff format, please fix as it would be already the case
Contributor
Author
There was a problem hiding this comment.
Replaced Black with Ruff format in commit 030d7a4.
.github/copilot-instructions.md
Outdated
| #### Python | ||
| - **Line length**: 120 characters | ||
| - **Target version**: Python 3.9+ | ||
| - **Formatter**: Black |
Contributor
Author
There was a problem hiding this comment.
Updated formatter reference to Ruff format in commit 030d7a4.
Member
|
@copilot please implement the review comments |
…chmark recommendation Co-authored-by: hombit <1784493+hombit@users.noreply.github.com>
Contributor
Author
hombit
approved these changes
Nov 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Setting up GitHub Copilot instructions for the repository
.github/copilot-instructions.mdfile with repository-specific guidanceSummary
Successfully created
.github/copilot-instructions.md(216 lines, 7.8 KB) with comprehensive guidance for GitHub Copilot when working with this repository. Updated based on reviewer feedback to reflect the transition from Black to Ruff format and added FFTW to system dependencies.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.