Skip to content

docs: consolidate Copilot instructions and fix workflow trigger #2536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
krlmlr merged 4 commits into from
Jan 24, 2026
Merged

docs: consolidate Copilot instructions and fix workflow trigger #2536

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4cf0d7d
Initial plan
Copilot Jan 24, 2026
759d6d8
docs: enhance Copilot instructions and fix workflow trigger path
Copilot Jan 24, 2026
ab5d07d
Tweak
krlmlr Jan 24, 2026
999aea5
Back
krlmlr Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,33 @@

> **Note**: For general development guidelines, code style conventions, and AI agent instructions, see [`AGENTS.md`](../AGENTS.md) in the repository root.

## Project Overview

igraph/rigraph is an R package for network analysis and graph theory with a C/C++ backend.

## Common Commands for Copilot Chat

- Load for development: `pkgload::load_all()`
- Run tests: `testthat::test_local(reporter = "check")`
- Run tests: `testthat::test_local()`
- Run tests for a single file: `testthat::test_local(filter = "foo")`
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test commands should include the reporter = "check" parameter to be consistent with AGENTS.md. The source of truth (AGENTS.md lines 39-40, 139) consistently specifies testthat::test_local(reporter = "check") for running tests. This parameter ensures consistent output formatting across different test runs.

Copilot uses AI. Check for mistakes.
- Format code: `air format .`
- Update documentation: `devtools::document()`
- Build package: `devtools::build()`
- Check package: `devtools::check()`

## Key Conventions

- Use `snake_case` for functions and arguments
- Follow tidyverse style guide
- Use roxygen2 with Markdown for documentation
- Run `air format .` before committing
- Add tests for all new functionality
- Use explicit package prefixes (e.g., `withr::local_db_connection()`)

## Important Files

- **Do not modify directly**: `src/rinterface.c`, `R/aaa-auto.R` (generated by Stimulus)
- Update generated files: `make -f Makefile-cigraph src/rinterface.c R/aaa-auto.R`
- See `tools/README.md` for Stimulus framework guidelines

Refer to `AGENTS.md` for more instructions.
Refer to `AGENTS.md` for complete instructions.
4 changes: 2 additions & 2 deletions .github/workflows/copilot-setup-steps.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ on:
workflow_dispatch:
push:
paths:
- .github/workflows/copilot-setup-steps.yml
- .github/workflows/copilot-setup-steps.yaml
pull_request:
paths:
- .github/workflows/copilot-setup-steps.yml
- .github/workflows/copilot-setup-steps.yaml

jobs:
# The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
Expand Down
Loading