diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 958b1ee..f67886d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,10 +8,7 @@ Fork and make your change. Make sure the tests pass: Push to your fork and [submit a pull request][pr]. -[pr]: https://github.com/bpinto/oh-my-fish/compare/ - -At this point you're waiting on us. We usually comment on pull requests -within a few hours. We may suggest some changes or improvements or alternatives. +At this point you're waiting on us. We usually comment on pull requests within a few hours. We may suggest some changes or improvements or alternatives. Some things that will increase the chance that your pull request is accepted: @@ -26,12 +23,14 @@ Some things that will increase the chance that your pull request is accepted: ### Plugins -If your plugin is complex, make sure to include tests, we suggest using [fish-spec](fish-spec). +If your plugin is complex, make sure to include tests, we suggest using [fish-spec][]. ### Themes Make sure to include a screenshot in your pull request, but don't commit the file to git. A nifty way is too post a comment with the image and link directly to it. + +[pr]: https://github.com/bpinto/oh-my-fish/compare/ [fish-spec]: https://github.com/bpinto/oh-my-fish/tree/master/plugins/fish-spec [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html [style]: #style-guide diff --git a/README.md b/README.md index 1e58222..d108b75 100644 --- a/README.md +++ b/README.md @@ -45,14 +45,11 @@ Before setting down on a theme, you might want to have a go with all themes usin ## Customization -If you have many functions which go well together, you can create custom plugin in the `custom/plugins/PLUGIN_NAME` -directory and add to it as many functions as you want. +If you have many functions which go well together, you can create custom plugin in the `custom/plugins/PLUGIN_NAME` directory and add to it as many functions as you want. -If you would like to use your custom theme, move it with the same name in the `custom/themes/` directory -and it will override the original theme in `themes/`. +If you would like to use your custom theme, move it with the same name in the `custom/themes/` directory and it will override the original theme in `themes/`. -If you just want to override any of the default behavior or add some environment variables, -just add a new file (ending in .load) into the `custom/` directory. +If you just want to override any of the default behavior or add some environment variables, just add a new file (ending in .load) into the `custom/` directory. ## Contributing