https://github.com/evuez/github-links-checker
A little bot that looks for broken links in your READMEs.
https://github.com/evuez/github-links-checker
Last synced: 9 months ago
JSON representation
A little bot that looks for broken links in your READMEs.
- Host: GitHub
- URL: https://github.com/evuez/github-links-checker
- Owner: evuez
- License: mit
- Created: 2015-11-12T16:37:40.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-04-09T08:01:26.000Z (about 8 years ago)
- Last Synced: 2024-10-30T00:33:37.350Z (over 1 year ago)
- Language: Python
- Size: 6.84 KB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 1,359
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub links checker
A little bot that looks for broken links in your READMEs.
## Installation
Requires Python >= 3.4
```
git clone git@github.com:evuez/github-links-checker.git
cd github-links-checker/
pip install -r requirements.txt
python github-links-checker.py
```
## Why?
I just don't like broken links.
At first I wanted to submit issues directly to repositories, but I think it's kinda spammy.
## WTF?
If you just got a mention from an issue in this repository, just remove that broken link from your README. You can then gently ask me to close this issue. Or I'll make another bot to make sure you did your work, cause I might be a bit too lazy to check all these issues.
## Your code is pretty awful, can I do something about it?
Fork, commit and PR, you know the drill.