diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000000..6111b7439c --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,14 @@ +This repo implements an automatic differentiation package for the Julia language. + +Please follow these guidelines when contributing: + +## Code Standards + +- Never commit changes to `Project.toml` to PRs. +- Format modified files using `JuliaFormatter`, eg, `using JuliaFormatter; format(".")` from the root of the repo. + +## Key Guidelines +- Follow Go best practices and idiomatic patterns +- Maintain existing code structure and organisation +- Write unit tests for new functionality. +- Document public APIs and complex logic. Suggest changes to the `docs/` folder when appropriate