openSUSE / openSUSE/doc-kit

Todos from the TODO file

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

Nobody has claimed this yet.

cat-bug scope-tool
Dominant language
Shell
Stars
5
Forks
3
Avg merge
2d 15h
Merged PRs (30d)
1

Description

  • Write files/SHA sums/variants into doc-kit.comf
  • Check SHA sum before update
  • Inform users about added/updated variants
  • Warn when git status is not clean
  • Allow a user-defined project name via {name} in $to file names & auto-detect if necessary to give name
  • Create boilerplate comments client-side: v/ # doc-kit-comment
  • Never overwrite initial filesystems
  • allow changing repo
  • package bin/
  • allow validating boilerplate repo structure, XML well-formedness (validation makes no sense), KITS, MANIFESTs, match file names, find typos in variants?
  • parseline() as function
  • allow changing doc-kit repo/branch or keep hard-coded?
  • mark variants with same prefix as colliding

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 TODO file and the existing package in bin/, then choose one unchecked item to scope separately. Review the related behavior around doc-kit.comf, repository or branch selection, and generated files as applicable; done means the selected item is implemented and its behavior can be verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.