kernelci / kernelci/kcidb

Add more schema documentation

Open
#10 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
26
Forks
40
PR merge metrics
No merged PRs in 30d

Description

Even though the schema is well-commented, it's still not describing some key design elements. Consider either embedding more documentation into the schema itself, or writing a separate document. Particularly including:

* Test classification tree
* Summarizing test runs
* Avoiding record duplicates
* Dealing with duplicates

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing schema comments and any separate documentation to identify the current coverage of test classification, test-run summaries, and duplicate handling. Done means documenting these four design elements clearly, either in the schema or a separate document, without leaving the intended approach ambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.