Add issue and pull request templates #241
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <!-- Thanks for taking the time to report your issue with _OHHTTPStubs_! When submitting your issue, please make sure to check the following boxes by putting an x in the appropriate [ ] so we can fully understand the context of your problem and help you better --> | ||
|
|
||
| ### New Issue Checklist | ||
|
There was a problem hiding this comment. There's an HTML comment on top of the |
||
|
|
||
| - [ ] I have tried with the latest version of OHHTTPStubs | ||
| - [ ] I have read the [README](https://github.com/AliSoftware/OHHTTPStubs/blob/master/README.md) | ||
| - [ ] I have read the [Using the right Swift Version of `OHHTTPStubs` for your project](https://github.com/AliSoftware/OHHTTPStubs#using-the-right-swift-version-of-ohhttpstubs-for-your-project) section | ||
| - [ ] I have searched in the [existing issues](https://github.com/AliSoftware/OHHTTPStubs/issues?utf8=✓&q=is%3Aissue) | ||
|
There was a problem hiding this comment. |
||
| - [ ] I have read [the OHHTTPStubs wiki](https://github.com/AliSoftware/OHHTTPStubs/wiki) to see if there wasn't a detailed page talking about my issue | ||
|
|
||
| ### Environment | ||
|
|
||
| - version of OHHTTPStubs: [LIB VERSION HERE] | ||
| - integration method you are using: | ||
| * [ ] Cocoapods | ||
| * [ ] Carthage | ||
| * [ ] submodule | ||
| * [ ] other | ||
| - version of the tool you use: [INSERT VERSION HERE] | ||
|
|
||
| ### Issue Description | ||
|
|
||
| [DESCRIBE YOUR ISSUE HERE] | ||
|
|
||
| ##### Complete output when you encounter the issue (if any) | ||
|
|
||
| ```[INSERT OUTPUT HERE]``` | ||
|
There was a problem hiding this comment. Sorry I wasn't clear, given that 3-backticks blocks are supposed to contain multiple lines of code, I expected to have them in dedicated lines to let them wrap a block (and not be inline), so more like this: There was a problem hiding this comment. Don't forget to address this one too 😉 |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <!-- Thanks for contributing to _OHHTTPStubs_! Before you submit your pull request, please make sure to check the following boxes by putting an x in the [ ] --> | ||
|
There was a problem hiding this comment. I just realised that HTML comments like those, not being markdown, won't be rendered, so that means that using underscores here isn't really useful. Maybe remove the underscores around |
||
|
|
||
| ### Checklist | ||
|
There was a problem hiding this comment. Please add an empty newline after markdown section titles (it's my OCD talking 😄) |
||
|
|
||
| - [ ] I've checked that all new and existing tests pass. | ||
| - [ ] I've updated the documentation if necessary. | ||
|
There was a problem hiding this comment. There was a problem hiding this comment. None of the other checklist items end with a period ( There was a problem hiding this comment. I'll remove the dots there then 👍 |
||
| - [ ] I've added an entry in the CHANGELOG to credit myself | ||
|
|
||
| ### Description | ||
|
|
||
|
|
||
| <!--- Describe your changes in detail --> | ||
|
|
||
| ### Motivation and Context | ||
|
|
||
|
|
||
| <!--- Why is this change required? What problem does it solve? --> | ||
| <!--- If it fixes an open issue, please link to the issue here. --> | ||
| <!--- Please describe in detail how you tested your changes. ---> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that I'm reading that again, the part "putting an x in the appropriate [ ]" feels like it's singular ("in the appropriate box") while we actually want to mean "in the appropriate boxes" — as the contributor should not limit their choices to only one box. Maybe changing the formulation to "putting an x in each appropriate [ ]" would help make that clearer?