Add AGENTS.md
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- cpp
- Domain
- documentation
Research direction
Start by inspecting the repository layout and any existing contributing guidance to identify the main workflows, commands, conventions, and testing expectations. Add an AGENTS.md or CLAUDE.md covering the requested sections and orienting new contributors to the C++ repository. Done means the file accurately reflects the repository and provides actionable guidance for development and pull requests.
Written by the indexing model from the issue text.
Description
Problem
add an AGENTS.md or CLAUDE.md file to this repository to standardize development with AI agents and orient them to the repo structure. This is becoming standard practice in open-source codebases.
Solution
Something with a structure like this maybe:
Project overview
Brief purpose and main workflows.
Repo layout
Key directories and what they contain.
Development commands
install, Test, lint, format, type check, docs, examples.
Coding conventions
Style, architecture boundaries, naming, error handling.
Testing expectations
Which tests to run for different change types.
Documentation practices
style, format, "Write so that a new developer to this codebase can understand your writing, don’t assume your audience are experts in the topic/area you are writing about."
Pull request checklist
What must be true before submitting changes.
Additional context
No response
Code of Conduct
- I agree to follow this project's Code of Conduct and Contributing Guidelines
- Dominant language
- C++
- Stars
- 22
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SimVascular/svZeroDSolver
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
SimVascular/svZeroDSolver#238 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
SimVascular/svZeroDSolver#246 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 48/100
SimVascular/svZeroDSolver#244 ·
-
bug
Difficulty 5/5 Over a week Newbie friendliness 35/100
SimVascular/svZeroDSolver#237 · 2 comments ·
-
Optional valve-state freezing for piecewise valves to prevent Newton cycling with 3D-0D coupling Openenhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
SimVascular/svZeroDSolver#228 · 9 comments ·
All issues in SimVascular/svZeroDSolver
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
bug-unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
NVIDIA/cuda-samples#453 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
infiniflow/infinity#3502 ·