https://github.com/dkhamsing/readme-correct
:grin: Fix GitHub typos with ease
https://github.com/dkhamsing/readme-correct
correct github readme typo
Last synced: 10 months ago
JSON representation
:grin: Fix GitHub typos with ease
- Host: GitHub
- URL: https://github.com/dkhamsing/readme-correct
- Owner: dkhamsing
- License: mit
- Created: 2016-02-19T23:03:48.000Z (almost 10 years ago)
- Default Branch: stable
- Last Pushed: 2017-05-29T13:38:46.000Z (over 8 years ago)
- Last Synced: 2024-10-19T01:15:51.989Z (over 1 year ago)
- Topics: correct, github, readme, typo
- Language: Ruby
- Homepage:
- Size: 8.79 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# readme-correct
The README correcting 🤖
`readme-correct` can open a pull request to correct a typo found in a GitHub README. The code is adapted from https://github.com/dkhamsing/cocoapods-readme :sparkles:
[](https://travis-ci.org/dkhamsing/readme-correct)
## Installation
```shell
$ git clone https://github.com/dkhamsing/readme-correct.git
$ cd readme-correct/
$ rake install
```
## Usage
Create a [`correct.yml` file](bin/correct.example.yml)
```yml
correct: Mississippi
incorrect:
- Missisipi
- Missisippi
- Mississipi
pull_commit_message: Correct the spelling of Mississippi in README
pull_request_title: Correct the spelling of Mississippi in README
pull_request_description: |
This pull request corrects the spelling of **Mississippi** 🤓
https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/M
Created with [`readme-correct`](https://github.com/dkhamsing/readme-correct).
```
Run `readme-correct`, it takes a GitHub repository as an argument.
```
$ readme-correct user/awesome-repo-with-typos
```
```
$ readme-correct dkarchive/Mississipi
```
:tada:
### Batch
You can even correct in batches with `batch-correct`, the input is a file with repos (one repo per line).
```
$ batch-correct list.txt
```
## Examples
- https://github.com/rnpm/rnpm/pull/94
- https://github.com/square/SocketRocket/pull/334
- https://github.com/foursquare/FSQCellManifest/pull/2
## Contact
- [github.com/dkhamsing](https://github.com/dkhamsing)
- [twitter.com/dkhamsing](https://twitter.com/dkhamsing)
## License
This project is available under the MIT license. See the [LICENSE](LICENSE) file for more info.