coreruleset / coreruleset/ftw-tests-schema

Generate schemas with documentation

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

Nobody has claimed this yet.

Dominant language
Go
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Out JSON schemas currently don't include documentation. They should.

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

No file or test is named. Start by locating the Go entry point that generates the JSON schemas and inspect how the source schema definitions are represented. Done means the generated schemas include the intended documentation and existing schema-generation checks still pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, json
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.