Improve documentation for Attribution
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python, yaml
- Domain
- cli, documentation
Research direction
Start by locating the ABCTK documentation and the help output for the transform command, especially the --help--format function mentioned in the issue. Reorganize the high-level documentation into Attribution and ABOUT files sections, placing attrib and transform under Attribution. Done means the transform YAML content is explained in the documentation without requiring an ABCTK installation.
Written by the indexing model from the issue text.
Description
Within the ABCTK documentation, we should make a distinction between the features and functions that operate on ABOUT files and those that do not require ABOUT files - namely Attribution. This means that we should organized the documentation at a high level under either Attribution or ABOUT files. The attrib and transform commands would be under Attribution and the rest under ABOUT files.
We also need a much more detailed explanation of the content of the transform yaml files - this could just be a copy of the help text from the --help--format function. We do not want to required someone to install ABCTK just to understand how the transform can work.
- Dominant language
- Python
- Stars
- 100
- Forks
- 48
- PR merge metrics
- No merged PRs in 30d
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aboutcode-org/aboutcode-toolkit
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Update PURLDB with all ABCTK releasesMay be free again @pombredanne claimed this 614 days ago, and no pull request is open. OpenImportant needs design
aboutcode-org/aboutcode-toolkit#582 · 2 comments · 3 assignees ·
-
Enhance `about_resource` to reference multiple files.May be free again @chinyeungli claimed this 266 days ago, and no pull request is open. Open
aboutcode-org/aboutcode-toolkit#566 · 2 comments · 1 assignee ·
-
Create test file with a few hundred itemsMay be free again @DennisClark claimed this 1731 days ago, and no pull request is open. Open
aboutcode-org/aboutcode-toolkit#491 · 2 assignees ·
-
Clean up / Organize codeMay be free again @sahil-MK2 claimed this 1750 days ago, and no pull request is open. Open
aboutcode-org/aboutcode-toolkit#483 · 1 comment · 2 assignees ·
All issues in aboutcode-org/aboutcode-toolkit
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
GoogleCloudPlatform/professional-services-data-validator#1899 ·
Maintainers usually reply within 4 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mohanraj00/entelos#200 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
sweep
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
bketelsen/truenas-mcp#77 ·
Maintainers usually reply within 1 day
-
Console writes URL credentials to the local log, though AGENTS.md says secrets never reach diskOpen
Difficulty 1/5 Under an hour Newbie friendliness 86/100
sandbox-quantum/switch#2163 ·
Maintainers usually reply within 1 day