-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
56fa9f5
commit 6e62d73
Showing
1 changed file
with
8 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,18 @@ | ||
# GitHub-Todo | ||
# YouShouldUse | ||
|
||
GitHub-Todo creates GitHub issues for every "TODO:" that you commit to your | ||
GitHub repostiory. | ||
:bread: YouShouldUse adds comments to GitHub pull requests for CSS code that breaks | ||
browser compatibility. :bread: | ||
|
||
## How to add it to your project | ||
|
||
1. Go to Settings, Webhooks & Services, Add Webhook | ||
2. Payload URL: `http://github-todo-issue.herokuapp.com/hook` | ||
3. Default options are fine | ||
4. Add webhook | ||
2. Payload URL: `http://youshoulduse.herokuapp.com/hook` | ||
3. Add webhook | ||
|
||
## How it works | ||
|
||
When you push code to your repository, Github-Todo scans the files in the new | ||
When you push code to your repository, YouShouldUse scans CSS files in the new | ||
commits. | ||
|
||
For every `TODO:` line in a file, it creates a new GitHub issue with a title | ||
matching the text following "`TODO:`" | ||
|
||
Note: Don't change the title of the created issues. GitHub-Todo uses them to | ||
keep from duplicating issues. | ||
|
||
# Disclamer | ||
|
||
This code is in no way affiliated with Github. Please file issues in this repo. | ||
Don't complain to Github if this breaks. | ||
|
||
# Our own TODOs | ||
|
||
* [ ] TODO: Pass jshint | ||
|
||
YouShouldUse runs doiuse against the CSS files in the pull request and adds a | ||
comment with the report results. |