Document variants
Open
Nobody has claimed this yet.
- Dominant language
- Dockerfile
- Stars
- 7
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Create a central place documenting all built variants.
Probably the best way would be a file along these lines:
versions:
v0.8.1:
changelog: Changelog URL
description: Our optional brief description of the version
variants:
monitoring:
description: Our description of a variant
only:
- limit variant to these versions only (ex. `-bitcoind0.19` variant is only useful for `lnd v0.8.0`)
experimental:
…
Such file would also be useful to generating Github Release descriptions, as well as README.md list of tags.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by comparing the proposed YAML structure with the README.md variant/tag list and the intended GitHub Release descriptions. Done means all built variants and their supported versions are represented in one central place, with enough information to support those descriptions and lists.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- build-system, documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100