theupdateframework / theupdateframework/taps
Define preferred style for wrapping and enforce with linter
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 37
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
Discussed during review of #163 (https://github.com/theupdateframework/taps/pull/163#issuecomment-1371392933) we should define a stance on wrapping and add a linter to ensure pull requests conform to the preferred style.
@mnm678 expressed a desire to support line-wrapping at sentences as is done in OCI specs (see https://github.com/opencontainers/image-spec#markdown-style), rather than a strict character limit.
Are there linters which support this option? When SLSA looked in mid 2021 we could not easily find something (see https://github.com/slsa-framework/slsa/issues/75).
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 reviewing the wrapping discussion in #163 and the linked OCI Markdown style guidance, then investigate linters that can wrap at sentence boundaries rather than enforcing a strict character limit. Done means the project has a documented preferred wrapping style and pull requests can be checked automatically for conformance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100