cyclus / cyclus/cyclus.github.com

Document "internal" db tables in kernel dev guide

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

Nobody has claimed this yet.

Dominant language
Python
Stars
8
Forks
33
PR merge metrics
No merged PRs in 30d

Description

Document purpose and details of tables like:

  • Prototypes
  • AgentState* tables
  • MaterialInfo
  • Recipes
  • etc.

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.

Research direction

Start with the kernel dev guide and inventory the internal tables named in the issue, including Prototypes, AgentState* tables, MaterialInfo, and Recipes. Document each table's purpose and details there; completion means the listed tables and other relevant internal tables are covered.

Written by the indexing model from the issue text.

Assessment

Domain
database, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.