[cordova-contribute] 06/07: description of GitHub templates

[ja...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

janpio pushed a commit to branch janpio-github_templates
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git

commit 85ba5f987c0d4aa5fb017b5ef3751e78a225d0bd
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Thu Aug 23 14:53:23 2018 +0200

    description of GitHub templates
---
 README.md           |  6 +++++-
 github-templates.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fbe1e3c..d411185 100644
--- a/README.md
+++ b/README.md
@@ -4,4 +4,8 @@ This repository contains documents describing everything a contributor of Apache
 
 > **Work in Progress**: This repository is very new and is currently very much "Work in Progress": content is created and added via Pull Requests.
 
-## Topics
\ No newline at end of file
+## Topics
+
+### Process
+
+- [GitHub Templates](github-templates.md)
diff --git a/github-templates.md b/github-templates.md
new file mode 100644
index 0000000..ddd37c3
--- /dev/null
+++ b/github-templates.md
@@ -0,0 +1,57 @@
+# GitHub Templates
+
+GitHub supports templates that are pre-populated into the description input field of a newly opened Issues and Pull Requests. Apache Cordova uses both options.
+
+## Issue Templates
+
+The job of an issue template is to make sure, the creator includes all necessary information in an issue they open. It can also supply information to the reporter like text or links that are relevant before opening an issue.
+
+Apache Cordova uses [GitHub's multiple issues template functionality](https://help.github.com/articles/about-issue-and-pull-request-templates/), which
+lets users choose what type of issue they want to create:
+
+Note: You can "test" and preview these issue templates by [creating an issue](/issues) in this repository.
+
+### Bug Report
+
+Collect all necessary information to understand if this is an actual bug or just a user problem. The information collected should enable the Apache Cordova community to reproduce and resolve the problem.
+
+See [`.github/ISSUE_TEMPLATE/BUG_REPORT.md`](.github/ISSUE_TEMPLATE/BUG_REPORT.md) for our current bug report template.
+
+### Feature Request
+
+What new feature is being requested and what problem does it solve?
+
+See [`.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md`](.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md) for our current feature request template.
+
+### Support Question
+
+People having problems with using one of Apache Cordova's components tend to also create issues. Apache Cordova unfortunately does not have the community to handle that volume of issues. Because of that, this template mainly refer people to the proper, more suited support channels:
+
+- Stack Overflow
+- Slack
+- Framework channels (like e.g. Ionic Forum)
+
+**Note that Apache Cordova will close support questions if they are submitted to the repository anyway.**
+
+See [`.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md`](.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md) for our current support question template.
+
+### Fallback
+
+Users can still ignore the specific issue templates by going to the `/issues/new` URL directly or use the "Don’t see your issue here? Open a regular issue." link below the template selection. This template provides the fallback for this case.
+
+See [`.github/ISSUE_TEMPLATE.md`](.github/ISSUE_TEMPLATE.md) for our current fallback issues template.
+
+## Pull Request Template
+
+Similar to an [Issue Template](#issue-template), the Pull Request template ensures that new Pull Requests include all necessary information. It is also used to nudge contributors to run tests, write documentation etc.
+
+See [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) for our current pull request template.
+
+## Distribute GitHub Templates to all repositories
+
+TODO
+<!--
+How can changes to these templates be distributed simply to all our (many) repositories?
+Maybe a shell script that copies to locally checked out repositories, then commits and pushes to all of them?
+cordova-coho maybe already does something like this?
+-->


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org