Skip to content

Add GitHub Copilot custom instructions from cardano-api #1351

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

Closed
Copilot wants to merge 2 commits into from
Closed

Add GitHub Copilot custom instructions from cardano-api #1351

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f73917a
Initial plan
Copilot Mar 19, 2026
1996e6e
Add copilot instructions
Copilot Mar 19, 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
20 changes: 20 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# GitHub Copilot Custom Instructions

## Haskell-Specific Guidance

### Qualified Import Aliases

In Haskell, it is valid and intentional to have multiple modules imported with the same qualified alias. For example:

```haskell
import Cardano.Api.Experimental qualified as Exp
import Cardano.Api.Experimental.Tx qualified as Exp
```

This is valid GHC Haskell — both modules can be referenced via the `Exp.` prefix. Name resolution happens at the use site; ambiguity only arises if both modules export the same identifier and it is used without disambiguation. Do **not** flag this pattern as a compile error or suggest renaming one of the aliases unless there is an actual ambiguity at a specific use site.

### Cabal File Formatting

In `.cabal` files, all top-level package metadata fields (`name:`, `version:`, `synopsis:`, `description:`, `copyright:`, `author:`, `maintainer:`, `license:`, `build-type:`, etc.) are written at column 0 with no leading indentation. This is the correct and standard Cabal format. Do **not** flag these fields as having inconsistent indentation or formatting issues — they are all intentionally at the same level.

When reviewing diffs of `.cabal` files, do **not** confuse diff context annotations (e.g., line numbers or `|` separators that appear in diff output) with actual file content. Only comment on the content of the file itself, not on artefacts of the diff format.
Loading