Added page describing how to create issues
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/c75dcc83 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/c75dcc83 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/c75dcc83 Branch: refs/heads/master Commit: c75dcc83fe93ce2c9d50a5ab1e2a21927410c46e Parents: a8fa0b6 Author: riknoll <[email protected]> Authored: Thu Nov 12 18:04:13 2015 -0800 Committer: Dmitry Blotsky <[email protected]> Committed: Wed Nov 18 15:21:29 2015 -0800 ---------------------------------------------------------------------- _config.yml | 2 ++ www/_layouts/contribute-help.html | 9 +++++++++ www/contribute/index.html | 2 +- www/contribute/issues.md | 32 ++++++++++++++++++++++++++++++++ www/static/css-src/_contribute.scss | 8 ++++++++ 5 files changed, 52 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c75dcc83/_config.yml ---------------------------------------------------------------------- diff --git a/_config.yml b/_config.yml index d35871a..946b278 100644 --- a/_config.yml +++ b/_config.yml @@ -71,6 +71,8 @@ redcarpet: # not have a leading or trailing newline - lax_spacing + - tables + kramdown: input: GFM hard_wrap: false http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c75dcc83/www/_layouts/contribute-help.html ---------------------------------------------------------------------- diff --git a/www/_layouts/contribute-help.html b/www/_layouts/contribute-help.html new file mode 100644 index 0000000..10882b9 --- /dev/null +++ b/www/_layouts/contribute-help.html @@ -0,0 +1,9 @@ +--- +layout: cordova +--- + +<div class="container"> + <div class="contribute-help"> +{{ content }} + </div> +</div> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c75dcc83/www/contribute/index.html ---------------------------------------------------------------------- diff --git a/www/contribute/index.html b/www/contribute/index.html index 37fdc0d..1029fe1 100644 --- a/www/contribute/index.html +++ b/www/contribute/index.html @@ -36,7 +36,7 @@ title: Contribute </div> <ul class="nav"> <li><a href="https://issues.apache.org/jira/browse/CB/?selectedTab=com.atlassian.jira.jira-projects-plugin:issues-panel";><span class="glyphicon glyphicon-warning-sign"></span><i> </i>View All Issues</a></li> - <li><a href="http://wiki.apache.org/cordova/ReportingBugs";><div class="report-bug-icon"></div><i> </i>Report a Bug</a></li> + <li><a href="./issues.html"><div class="report-bug-icon"></div><i> </i>Report a Bug</a></li> <li><a href="https://people.apache.org/committer-index.html";><span class="glyphicon glyphicon-user"></span><i> </i>View Committers / Non-Committers</a></li> </ul> </div> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c75dcc83/www/contribute/issues.md ---------------------------------------------------------------------- diff --git a/www/contribute/issues.md b/www/contribute/issues.md new file mode 100644 index 0000000..3ef1a4b --- /dev/null +++ b/www/contribute/issues.md @@ -0,0 +1,32 @@ +--- +layout: contribute-help +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 [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 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. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c75dcc83/www/static/css-src/_contribute.scss ---------------------------------------------------------------------- diff --git a/www/static/css-src/_contribute.scss b/www/static/css-src/_contribute.scss index e4abb33..1567094 100644 --- a/www/static/css-src/_contribute.scss +++ b/www/static/css-src/_contribute.scss @@ -128,3 +128,11 @@ a:hover .report-bug-icon { margin-bottom:.5em; } } + +// Issues and Contributing guides within contribute +.contribute-help { + table { + @extend .table; + @extend .table-bordered; + } +} --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
