diff options
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c17787041..ac263fd18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,10 +36,10 @@ Then, you can go ahead and create an issue with as much detail as you can provid It should include the data gathered as indicated above, along with: 1. How to reproduce the problem -2. What the expected behavior should be +2. What the correct behavior should be 3. What the actual behavior is -Please copy to anyone relevant (e.g. plugin maintainers) by mentioning their GitHub handle +Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. We will do our very best to help you. @@ -51,7 +51,7 @@ your suggestion. If you find one, comment on it so we can know there are more people supporting it. -If not, you can go ahead and create an issue. Please copy to anyone relevant (e.g. plugin +If not, you can go ahead and create an issue. Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. ## Submitting Pull Requests @@ -86,15 +86,15 @@ maintainers) by mentioning their GitHub handle (starting with `@`) in your messa Please [do not](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now) send themes for now. -Please be so kind as to [search](#use-the-search-luke) for any pending/merged/rejected PR covering or -related to what you want to add. +Please be so kind as to [search](#use-the-search-luke) for any pending, merged or rejected Pull Requests +covering or related to what you want to add. If you find one, try it out and work with the author on a common solution. -If not, then go ahead and submit a PR. Please copy to anyone relevant (e.g. plugin +If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. -For any extensive change, e.g. a new plugin, you will have to find testers to +1 your PR. +For any extensive change, _eg_ a new plugin, you will have to find testers to +1 your PR. ---- |