diff --git a/README.md b/README.md index 0dd6fa606c..dd0e339b41 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,10 @@ $ open ~/Applications/"Google Chrome.app" We’re really rather friendly! Here are the best places to talk about the project: -* Start an [issue on GitHub](https://github.com/caskroom/homebrew-cask/issues/new) +* Start an issue on GitHub using one of these templates: + * [Bug report][bug_report_template] + * [Feature request][feature_request_template] + * [Cask request][cask_request_template] * Join us on IRC, we’re at `#homebrew-cask` on Freenode ## Reporting Bugs @@ -65,3 +68,7 @@ If the issue persists, please run the problematic command with the `--verbose` f ## License: Code is under the [BSD 2 Clause (NetBSD) license](LICENSE) + +[bug_report_template]: https://github.com/caskroom/homebrew-cask/issues/new?title=Bug%20report%3A&body=%28Remember%20to%20run%20%60brew%20update%3B%20brew%20cleanup%3B%20brew%20cask%20cleanup%60%20before%20reporting%20your%20issue.%20It%20usually%20fixes%20things%21%29%0A%0A%23%23%23%20Description%20of%20issue%0A%0A%0A%0A%23%23%23%20Output%20of%20%60brew%20cask%20%3Ccommand%3E%20--verbose%60%0A%0A%60%60%60%0A%28paste%20output%20here%29%0A%60%60%60%0A%0A%23%23%23%20Output%20of%20%60brew%20doctor%60%0A%0A%60%60%60%0A%28paste%20output%20here%29%0A%60%60%60%0A%0A%23%23%23%20Output%20of%20%60brew%20cask%20doctor%60%0A%0A%60%60%60%0A%28paste%20output%20here%29%0A%60%60%60%0A +[cask_request_template]: https://github.com/caskroom/homebrew-cask/issues/new?title=Cask%20request%3A&body=%23%23%23%20Cask%20details%0A%0A%28Please%20fill%20out%20as%20much%20as%20possible%29%0A%0A%2A%2AName%2A%2A%20-%0A%2A%2AHomepage%2A%2A%20-%0A%2A%2ALicense%2A%2A%20-%0A%2A%2ADownload%20URL%2A%2A%20-%0A%2A%2ADescription%2A%2A%20-%0A +[feature_request_template]: https://github.com/caskroom/homebrew-cask/issues/new?title=Feature%20request%3A&body=%23%23%23%20Description%20of%20feature%2Fenhancement%0A%0A%0A%0A%23%23%23%20Justification%0A%0A%0A%0A%23%23%23%20Example%20use%20case%0A%0A%0A%0A diff --git a/doc/issue_templates/bug_report.md b/doc/issue_templates/bug_report.md new file mode 100644 index 0000000000..4439201608 --- /dev/null +++ b/doc/issue_templates/bug_report.md @@ -0,0 +1,24 @@ +Bug report: +(Remember to run `brew update; brew cleanup; brew cask cleanup` before reporting your issue. It usually fixes things!) + +### Description of issue + + + +### Output of `brew cask --verbose` + +``` +(paste output here) +``` + +### Output of `brew doctor` + +``` +(paste output here) +``` + +### Output of `brew cask doctor` + +``` +(paste output here) +``` diff --git a/doc/issue_templates/cask_request.md b/doc/issue_templates/cask_request.md new file mode 100644 index 0000000000..c6f778ede3 --- /dev/null +++ b/doc/issue_templates/cask_request.md @@ -0,0 +1,10 @@ +Cask request: +### Cask details + +(Please fill out as much as possible) + +**Name** - +**Homepage** - +**License** - +**Download URL** - +**Description** - diff --git a/doc/issue_templates/feature_request.md b/doc/issue_templates/feature_request.md new file mode 100644 index 0000000000..ed78b1a8af --- /dev/null +++ b/doc/issue_templates/feature_request.md @@ -0,0 +1,13 @@ +Feature request: +### Description of feature/enhancement + + + +### Justification + + + +### Example use case + + +