SimVascular / SimVascular/svZeroDSolver

Add AGENTS.md

Open Beginner friendly
#232 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
22
Forks
44
PR merge metrics
No merged PRs in 30d

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.