add AI instruction markdown#286
Open
TendonFFF wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds AI-focused documentation files intended to provide project context and common developer commands for HierarchicalEOM.jl, primarily to guide automated coding assistants.
Changes:
- Adds
CLAUDE.mdwith commonmakecommands and workflow notes (format/test/docs/CI). - Adds
.github/copilot-instructions.mddescribing project structure, key concepts, dependencies, and testing/quality practices for GitHub Copilot.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
CLAUDE.md |
Adds a concise “common commands + notes” entrypoint referencing the full instructions file. |
.github/copilot-instructions.md |
Adds detailed Copilot guidance on architecture, conventions, dependencies, and testing/quality. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Testing & Quality | ||
|
|
||
| - Tests live in `test/`. Each major component has its own file. | ||
| - Run tests with `julia --project=test test/runtests.jl` or via `Pkg.test()`. |
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
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.
Checklist
Thank you for contributing to
HierarchicalEOM.jl! Please make sure you have finished the following tasks before opening the PR.make test.juliaformatted by running:make format.docs/folder) related to code changes were updated and able to build locally by running:make docs.Request for a review after you have completed all the tasks. If you have not finished them all, you can also open a Draft Pull Request to let the others know this on-going work.
Description
As title