[Suggestion] Use a brok to find broken links
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 944
- Forks
- 673
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 9
Description
Motivation
It is common PRs to correct or remove links that are broken.
The problem is when no one opens a PR and the link is broken forever.
How
Use an external tool (https://github.com/smallhadroncollider/brok) to check broken links.
We can create an job to run every week or a pre-commit hook...
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 brok tool at https://github.com/smallhadroncollider/brok and compare the two integration options mentioned: a weekly job or a pre-commit hook. The issue names no repository files or tests; done would mean selecting and integrating an automated broken-link check for this site.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100