README.md in safe_pusher-0.4.0 vs README.md in safe_pusher-0.4.1

- old
+ new

@@ -2,11 +2,11 @@ [![Maintainability](https://api.codeclimate.com/v1/badges/1aa6c275f9ce4d4c6ec3/maintainability)](https://codeclimate.com/github/williampollet/safe_pusher/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/1aa6c275f9ce4d4c6ec3/test_coverage)](https://codeclimate.com/github/williampollet/safe_pusher/test_coverage) # SafePusher -Run your favorite linters and specs on the files you touched, before pushing your branch. +Run your favorite linters and specs on the files you touched, before committing and pushing your branch. ## Installation Add these lines to your application's Gemfile: @@ -38,14 +38,22 @@ - file/to/skip_1 - file/to/skip/2 base_branch: developement # default master app_base_directory: app repo_url: https://github.com/williampollet/safe_pusher +services: + test: rspec + lint: pronto + push: github + open: github + add: git + amend: git + commit: git +verbose: true ``` ## Usage - To see the commands available, type: $ safepush To run pronto checks before you push to GitHub run: @@ -62,10 +70,34 @@ or $ safepush t l p o +### Available commands so far + - `test` (runs the tests only on the files you touched) + - `lint` (runs a linter only on the files you touched) + - `commit` (commit your changes) + - `add` (track your changes) + - `amend` (amend your tracked changes to your last commit) + - `push` (push and set upstream your local branch on github) + - `open` (open a pull request on github) + ## Contributing + +You can easily add a new client, or a new command. + +### To add a client + - create the client api under `lib/safe_pusher/client/***.rb` + - require it in `lib/safe_pusher.rb` + - write the specs for your client, then submit a PR + - You will be able to specify in which command to use it, via the configuration ! + +### To add a command + - configure your command and its client in `config/commands.yml` + - create your safepusher client api, as detailed above (if necessary) + - include your command's description in the help, in `config/en.yml` + +### Guidelines Bug reports and pull requests are welcome on GitHub at https://github.com/williampollet/safe_pusher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## Development