From ed73a72cbe1f3898818825c44e3b6df91cc6c29a Mon Sep 17 00:00:00 2001 From: Colin Seymour Date: Mon, 15 Jan 2018 10:11:53 +0000 Subject: [PATCH] Add issue and pull request templates (#3972) * Add issue and pull request templates * Implement feedback * Request new and old grammar refs * Add note about vendor, documentation, and generated lists * Implement @Alhadis's suggestions --- .github/ISSUE_TEMPLATE.md | 26 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 46 ++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..905543bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,26 @@ + + +## Preliminary Steps + +Please confirm you have... +- [ ] reviewed [How Linguist Works](https://github.com/github/linguist#how-linguist-works), +- [ ] reviewed the [Troubleshooting](https://github.com/github/linguist#troubleshooting) docs, +- [ ] considered implementing an [override](https://github.com/github/linguist#overrides), +- [ ] verified an issue has not already been logged for your issue ([linguist issues](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+repo%3Agithub/linguist)). + + + +## Problem Description + + + +### URL of the affected repository: + +### Last modified on: + + +### Expected language: + + +### Detected language: + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..c760b34c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,46 @@ + + +## Description + + +## Checklist: + + +- [ ] **I am associating a language with a new file extension.** + - [ ] The new extension is used in hundreds of repositories on GitHub.com + - Search results for each extension: + + - https://github.com/search?utf8=%E2%9C%93&type=Code&ref=searchresults&q=extension%3AFOOBAR+KEYWORDS+NOT+nothack + - [ ] I have included a real-world usage sample for all extensions added in this PR: + - Sample source(s): + - [URL to each sample source, if applicable] + - Sample license(s): + - [ ] I have included a change to the heuristics to distinguish my language from others using the same extension. + +- [ ] **I am adding a new language.** + - [ ] The extension of the new language is used in hundreds of repositories on GitHub.com. + - Search results for each extension: + + - https://github.com/search?utf8=%E2%9C%93&type=Code&ref=searchresults&q=extension%3AFOOBAR+KEYWORDS+NOT+nothack + - [ ] I have included a real-world usage sample for all extensions added in this PR: + - Sample source(s): + - [URL to each sample source, if applicable] + - Sample license(s): + - [ ] I have included a syntax highlighting grammar. + - [ ] I have included a change to the heuristics to distinguish my language from others using the same extension. + +- [ ] **I am fixing a misclassified language** + - [ ] I have included a new sample for the misclassified language: + - Sample source(s): + - [URL to each sample source, if applicable] + - Sample license(s): + - [ ] I have included a change to the heuristics to distinguish my language from others using the same extension. + +- [ ] **I am changing the source of a syntax highlighting grammar** + + - Old: https://github-lightshow.herokuapp.com/ + - New: https://github-lightshow.herokuapp.com/ + +- [ ] **I am adding new or changing current functionality** + + - [ ] I have added or updated the tests for the new or changed functionality.