Add developer/design documentation.

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

The issue names no files, tests, or existing documentation to update. Start by surveying the repository structure and current contributor materials, then clarify the documentation scope and expected audience with maintainers. Done should include the agreed design and contribution documentation, with its location and coverage explicitly defined.

Written by the indexing model from the issue text.

Description

Add some documentation of the software's design, contribution guidelines, etc.

Dominant language
C++
Stars
236
Forks
47
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from llnl/libROM

All issues in llnl/libROM

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.