Add issue and pull request templates #241
Conversation
| - [ ] 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
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| ##### Complete output when you encounter the issue (if any) | ||
|
|
||
| [INSERT OUTPUT HERE] |
There was a problem hiding this comment.
We should insert 3-backticks before and after that line to encourage people to put their output in them and have a nicely-formatted terminal output
We could even prepare a <details> block for them (so that if the terminal output they paste is long it doesn't make the issue description too unreadable), but I'm afraid doing that would be disturbing to people not knowing this tag
| @@ -0,0 +1,24 @@ | |||
| ### New Issue Checklist | |||
There was a problem hiding this comment.
There's an HTML comment on top of the PULL_REQUEST_TEMPLATE.md down below, why not adding a similar one here too?
<!-- 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 -->
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| ### Checklist | ||
| - [ ] I've checked that all new and existing tests pass. | ||
| - [ ] I've updated the documentation if necessary. |
There was a problem hiding this comment.
- [ ] I've added an entry in the CHANGELOG to credit myself
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| <!-- 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 [ ] --> | |||
|
|
|||
| ### Checklist | |||
There was a problem hiding this comment.
Please add an empty newline after markdown section titles (it's my OCD talking 😄)
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| - [ ] I've checked that all new and existing tests pass. | ||
| - [ ] I've updated the documentation if necessary. | ||
|
|
||
| ### Description |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| ### Description | ||
| <!--- Describe your changes in detail --> | ||
|
|
||
| ### Motivation and Context |
.github/ISSUE_TEMPLATE.md
Outdated
| @@ -21,4 +24,4 @@ | |||
|
|
|||
| ##### Complete output when you encounter the issue (if any) | |||
|
|
|||
| [INSERT OUTPUT HERE] | |||
| ```[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:
```
[INSERT OUTPUT HERE]
```
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -1,13 +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 OHHTTPStubs to make it read better when unformatted? (same for the issue template obviously)
.github/ISSUE_TEMPLATE.md
Outdated
| @@ -1,9 +1,12 @@ | |||
| <!-- 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 --> | |||
There was a problem hiding this comment.
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?
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| ### Checklist | ||
|
|
||
| - [ ] I've checked that all new and existing tests pass. | ||
| - [ ] I've updated the documentation if necessary. |
There was a problem hiding this comment.
None of the other checklist items end with a period (.), so why those two? 🤔
(I'm OK for either style… as long as it's applied consistently 😄 )
There was a problem hiding this comment.
I'll remove the dots there then 👍
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| ##### Complete output when you encounter the issue (if any) | ||
|
|
||
| ```[INSERT OUTPUT HERE]``` |
There was a problem hiding this comment.
Don't forget to address this one too 😉
```
[INSERT OUTPUT HERE]
```
|
Perfect ! Ready to merge once Travis wakes up. |
Checklist
Description
This adds issue and pull requests templates to help users and contributors.
I used the fastlane's ones as a reference.
Any feedback and suggestions welcome!
Motivation and Context
This is an implementation for #210