GithubHelp home page GithubHelp logo

readme-correct's Introduction

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 ✨

Build Status

Installation

$ git clone https://github.com/dkhamsing/readme-correct.git
$ cd readme-correct/
$ rake install

Usage

Create a correct.yml file

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

🎉

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

Contact

License

This project is available under the MIT license. See the LICENSE file for more info.

readme-correct's People

Contributors

dkhamsing avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.