aboutsummaryrefslogtreecommitdiffstats
path: root/site/contribute/issues.md
diff options
context:
space:
mode:
authorStephane Desneux <stephane.desneux@iot.bzh>2016-11-08 12:39:57 +0100
committerStephane Desneux <stephane.desneux@iot.bzh>2016-11-10 14:53:01 +0100
commitc530e84843444a40804e0c2b038c2ec53fe411b2 (patch)
tree1a9eebf49fd85027ba472bad8c178d686bad8d56 /site/contribute/issues.md
webdocs-agl: added developer website template
Change-Id: I4a45ee0ad5dd0c29a6d6876a0e02cd5550c010e9 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'site/contribute/issues.md')
-rw-r--r--site/contribute/issues.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/site/contribute/issues.md b/site/contribute/issues.md
new file mode 100644
index 0000000..6edebaf
--- /dev/null
+++ b/site/contribute/issues.md
@@ -0,0 +1,55 @@
+---
+layout: contribute
+title: Apache Cordova Reporting Issues
+---
+
+# Reporting Issues
+
+Thank you for helping to improve Cordova! Issues for Apache Cordova are hosted at the Apache [JIRA](https://issues.apache.org/jira/browse/CB). A JIRA account is required before you can submit issues (you can easily [create one here](https://issues.apache.org/jira/secure/Signup!default.jspa)). Before submitting an issue, please take a moment to search JIRA to see if an issue already exists. If it does, please consider commenting or voting for the issue to help raise its visibility.
+
+
+## Creating an issue in JIRA
+
+Once you have created an account and logged in, click the blue "Create" button at the top of the [Cordova JIRA](https://issues.apache.org/jira/browse/CB) page to create an issue. In the dialog that appears, please fill out the following fields _to the best of your ability_. All fields besides those listed here can be left blank.
+
+Field | Description
+----------------| -----
+Project | Make sure that Apache Cordova is selected
+Issue Type | Whether or not this is a bug or feature request
+Summary | A one line description of the issue
+Component | The [part of Cordova](https://issues.apache.org/jira/browse/CB/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel) this issue pertains to. Please select only one component if possible (e.g. if you find a bug while using cordova-plugin-camera in Android, select the "Plugin Camera" component and not "Android")
+Affects Version | The version of the component that this issue pertains to
+Environment | Some extra context about the environment in which a bug was found (e.g. the version of Android you are running, your version of the Cordova CLI, your development platform, etc.)
+Description | A thorough description of the issue. For bugs, please provide code (using github) or steps for reproduction as well as any device logs or stack traces you might have.
+Labels | Please label your issue with the platforms it affects (e.g. ios, windows, android, etc.) and nothing else
+Priority | The impact of the issue (see below)
+
+## Issue Priority
+
+We gauge issue priority on the following scale:
+* **Minor/Trivial:** The feature or bug is very specific or only affects a few people
+* **Major:** The feature or bug is important and impacts many people
+* **Critical:** Bugs (not features) that block the main function of a component and affect a large number of people (e.g. the camera plugin can't take pictures in iOS version x.x)
+* **Blocker:** Catastrophic bugs that prevent projects from building or cause basic projects to crash immediately. It is very unlikely that a bug is a Blocker
+
+If you aren't sure about the priority, leave the default (major) selected. Please be aware that as our contributors triage issues, they may change the priority based on our criteria.
+
+## Finding out versions
+
+You can quickly find out versions of platforms/plugins you're using by running:
+
+ cordova platform ls
+
+or
+
+ cordova plugin ls
+
+in your project respectively. You can find out the version of the Cordova CLI you're using by running:
+
+ cordova --version
+
+# Generating CLI logs
+
+You can use `--verbose` flag to generate detailed logs for cordova build-time bugs related with the CLI. This helps significantly in debugging.
+
+