You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2018/09/24 10:20:54 UTC
svn commit: r1841825 - in /cordova/site/public:
contribute/contribute_guidelines.html contribute/issues.html feed.xml
plugins/faq.html
Author: steven
Date: Mon Sep 24 10:20:54 2018
New Revision: 1841825
URL: http://svn.apache.org/viewvc?rev=1841825&view=rev
Log:
Updated docs
Modified:
cordova/site/public/contribute/contribute_guidelines.html
cordova/site/public/contribute/issues.html
cordova/site/public/feed.xml
cordova/site/public/plugins/faq.html
Modified: cordova/site/public/contribute/contribute_guidelines.html
URL: http://svn.apache.org/viewvc/cordova/site/public/contribute/contribute_guidelines.html?rev=1841825&r1=1841824&r2=1841825&view=diff
==============================================================================
--- cordova/site/public/contribute/contribute_guidelines.html (original)
+++ cordova/site/public/contribute/contribute_guidelines.html Mon Sep 24 10:20:54 2018
@@ -118,50 +118,39 @@
<h2>Prerequisites</h2>
-<p>Before contributing to Apache Cordova, it is recommended that you complete the following steps:</p>
-
-<ol>
-<li>Join the <a href="http://cordova.apache.org/contact/">mailing list</a> and send a brief introduction of yourself (optional)</li>
-<li>Create an <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">Apache JIRA</a> account</li>
-</ol>
+<p>Before contributing to Apache Cordova, it is recommended that you join the <a href="http://cordova.apache.org/contact/">mailing list</a> and send a brief introduction of yourself.</p>
<h2>Working with Issues</h2>
-<p>Issues for most Apache Cordova components are hosted in the <a href="https://issues.apache.org/jira/browse/CB">Apache JIRA</a>. However, some components instead have their issues on GitHub. If a repository has an <em>Issues</em> tab on GitHub, issues should be reported there instead of JIRA. All code contributions made to Cordova should have a corresponding JIRA or GitHub issue. When reporting issues, please follow <a href="./issues.html">these guidelines</a>.</p>
+<p>Issues for all Apache Cordova components are on <a href="https://github.com/apache/cordova">GitHub</a>. When reporting issues, please follow <a href="./issues.html">these guidelines</a>.</p>
<h4>Claiming Issues</h4>
-<p>If you find an issue that you would like to work on, you can ask to claim it; please leave a comment indicating your intention and a committer will assign it to you. Some issues in JIRA are auto-assigned to certain contributors. If it is clear that an issue is not being worked on, feel free to work on it yourself (but please comment first to let the assignee know). If you are looking for a place to start, try searching the <a href="https://issues.apache.org/jira/issues?jql=project%20%3D%20CB%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20%22easyfix%22%20ORDER%20BY%20createdDate%20DESC">issues labelled easyfix in JIRA</a>.</p>
+<p>If you find an issue that you would like to work on, you can ask to claim it; please leave a comment indicating your intention and a committer will assign it to you. If it is clear that an issue is not being worked on, feel free to work on it yourself (but please comment first to let the assignee know).</p>
<h2>Submitting Code</h2>
-<p>You can submit code using one of the following methods:</p>
-
-<ul>
-<li>Submit a pull request at one of the Apache Github mirrors at <code>github.com/apache/<repo name></code> (<strong>Strongly Preferred</strong>)</li>
-<li>Upload patches created with <code>git format-patch</code> to the JIRA issue</li>
-<li>Paste a diff to JIRA (you won't get authorship if you do this)</li>
-</ul>
+<p>You can submit code by submitting a pull request at one of the Apache Github mirrors at <code>github.com/apache/<repo name></code>.</p>
<h4>Making Pull requests</h4>
<p>The workflow for creating pull requests on Github generally follows these steps:</p>
<ol>
-<li><a href="./issues.html">Open an issue</a> if one has not already been created (optional if the repository's issues are on GitHub instead of JIRA)</li>
-<li><a href="https://help.github.com/articles/fork-a-repo/">Create a local fork</a> of the appropriate Apache repository</li>
+<li><a href="./issues.html">Open an issue</a> if one has not already been created (optional)</li>
+<li><a href="https://help.github.com/articles/fork-a-repo/">Create a local fork</a> of the appropriate Cordova repository</li>
<li>In your local fork, create a branch dedicated to the issue you are working on</li>
<li>Push your commits to this branch</li>
<li><a href="http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits">Squash</a> these commits into one single commit (see the section below regarding commit messages)</li>
-<li><a href="https://help.github.com/articles/using-pull-requests/">Create a pull request</a> on the Apache repository</li>
+<li><a href="https://help.github.com/articles/using-pull-requests/">Create a pull request</a> on the Cordova repository</li>
<li>Ask for code review</li>
</ol>
-<p>Please include the issue id in the title of any pull requests made to Github. The Apache Git bot will link a PR and the JIRA issue automatically if it finds a JIRA issue ID in the commit message. For more help on Git, see the <a href="http://git-scm.com/doc">Git documentation</a>.</p>
+<p>Please include the issue ID in the title of any pull requests made to Github. For more help on Git, see the <a href="http://git-scm.com/doc">Git documentation</a>.</p>
<h4>Code review</h4>
-<p>However you submit code, you should always call out a reviewer to look at and merge your code. A good place to find a reviewer is <a href="https://issues.apache.org/jira/browse/CB/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel">the component list on JIRA</a> or you can send a mail out to the <a href="http://cordova.apache.org/contact">dev mailing list</a> with a link to the pull request.</p>
+<p>However you submit code, you should always call out a reviewer to look at and merge your code. GitHub helpfully suggests possible reviewers whom you can add, or you can send a mail out to the <a href="http://cordova.apache.org/contact">dev mailing list</a> with a link to the pull request.</p>
<h2>Testing your code</h2>
@@ -191,16 +180,12 @@
<h2>Git Commit Messages</h2>
-<p>When contributing, please have your commit messages begin with the the issue id (if there is one) and relevant platform (if appropriate) followed by a description of the commit. Here are two examples for JIRA tickets:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">CB-2345 android: Improved exec bridge by using strings instead of JSON
-CB-3456 all: Fixed plugin loading paths that start with /
-</code></pre></div>
-<p>If you created an issue on GitHub, the issue number starts with <code>GH</code> instead of <code>CB</code>:</p>
+<p>When contributing, please start your commit messages with the the issue ID (if there is one) and relevant platform (if appropriate) followed by a description of the commit. Issue IDs on GitHub should be prefixed with <code>GH-</code>, which will allow GitHub to automatically link issues and PRs.</p>
<div class="highlight"><pre><code class="language-" data-lang="">GH-2345 android: Improved exec bridge by using strings instead of JSON
GH-3456 all: Fixed plugin loading paths that start with /
</code></pre></div>
<p>You are highly encouraged to describe your git commit with enough detail for someone else to understand it. In doing so, your commit message can consist of multiple lines. However, it also is highly encouraged that the first line of your commit message not exceed 50 characters. This is because some of the tooling that sits on top of git (such as the httpd apps that let you browse the repos) assumes that the first line is top-level summary that is 50 characters or less. Thus there will be highlighting and truncating of the commit message using these assumptions and it will look weird if these assumptions are not kept. There should also be a blank line between the summary and any further description. For example, here is a good commit message:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">CB-1234 Fixed the whizbang widget
+<div class="highlight"><pre><code class="language-" data-lang="">GH-1234 Fixed the whizbang widget
- added more sanity checking in the build script.
- fixed the API to return the correct value in the scenario where there
Modified: cordova/site/public/contribute/issues.html
URL: http://svn.apache.org/viewvc/cordova/site/public/contribute/issues.html?rev=1841825&r1=1841824&r2=1841825&view=diff
==============================================================================
--- cordova/site/public/contribute/issues.html (original)
+++ cordova/site/public/contribute/issues.html Mon Sep 24 10:20:54 2018
@@ -114,11 +114,7 @@
<div class="contribute-help">
<h1>Reporting Issues</h1>
-<p>Thank you for helping to improve Cordova! Most issues for Apache Cordova are currently hosted at the <a href="https://issues.apache.org/jira/browse/CB">Apache JIRA</a>. However, we are starting to move issue management to GitHub.</p>
-
-<h2>Should I report an issue on JIRA or GitHub?</h2>
-
-<p>If the repository you are reporting an issue for has an <em>Issues</em> tab on GitHub, please report it there. Otherwise report it on JIRA.</p>
+<p>Thank you for helping to improve Cordova! All Cordova issues should now be reported on <a href="https://github.com/apache/cordova">GitHub</a>. Our JIRA issue tracker has been closed, and new issues can no longer be opened there.</p>
<h2>Creating an issue on GitHub</h2>
@@ -131,57 +127,7 @@
<li><a href="https://github.com/apache/cordova-docs">cordova-docs</a>: the Cordova website and documentation</li>
</ul>
-<p>Once you have found the correct repository to create your issue in, go to the <em>Issues</em> tab, and click <em>New issue</em>. Simply fill out the issue template, and submit your issue. If there is no <em>Issues</em> tab, please report the issue on JIRA instead.</p>
-
-<h2>Creating an issue in JIRA</h2>
-
-<p>A JIRA account is required before you can submit issues (you can easily <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">create one here</a>). 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.</p>
-
-<p>Once you have created an account and logged in, click the blue "Create" button at the top of the <a href="https://issues.apache.org/jira/browse/CB">Cordova JIRA</a> page to create an issue. In the dialog that appears, please fill out the following fields <em>to the best of your ability</em>. All fields besides those listed here can be left blank.</p>
-
-<table><thead>
-<tr>
-<th>Field</th>
-<th>Description</th>
-</tr>
-</thead><tbody>
-<tr>
-<td>Project</td>
-<td>Make sure that Apache Cordova is selected</td>
-</tr>
-<tr>
-<td>Issue Type</td>
-<td>Whether or not this is a bug or feature request</td>
-</tr>
-<tr>
-<td>Summary</td>
-<td>A one line description of the issue</td>
-</tr>
-<tr>
-<td>Component</td>
-<td>The <a href="https://issues.apache.org/jira/browse/CB/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel">part of Cordova</a> 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")</td>
-</tr>
-<tr>
-<td>Affects Version</td>
-<td>The version of the component that this issue pertains to</td>
-</tr>
-<tr>
-<td>Environment</td>
-<td>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.)</td>
-</tr>
-<tr>
-<td>Description</td>
-<td>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.</td>
-</tr>
-<tr>
-<td>Labels</td>
-<td>Please label your issue with the platform it affects (e.g. ios, windows, android, etc.). Include other relevant labels such as regression, easyfix, bug, dev, staging, production, discussion, question, security, legal, enhancement, production, and/or feature.</td>
-</tr>
-<tr>
-<td>Priority</td>
-<td>The impact of the issue (see below)</td>
-</tr>
-</tbody></table>
+<p>Once you have found the correct repository to create your issue in, go to the <em>Issues</em> tab, and click <em>New issue</em>. Simply fill out the issue template, and submit your issue.</p>
<h1>Issue Priority</h1>
Modified: cordova/site/public/feed.xml
URL: http://svn.apache.org/viewvc/cordova/site/public/feed.xml?rev=1841825&r1=1841824&r2=1841825&view=diff
==============================================================================
--- cordova/site/public/feed.xml (original)
+++ cordova/site/public/feed.xml Mon Sep 24 10:20:54 2018
@@ -6,8 +6,8 @@
</description>
<link>https://cordova.apache.org/</link>
<atom:link href="https://cordova.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Sun, 23 Sep 2018 13:46:04 +0000</pubDate>
- <lastBuildDate>Sun, 23 Sep 2018 13:46:04 +0000</lastBuildDate>
+ <pubDate>Mon, 24 Sep 2018 09:56:09 +0000</pubDate>
+ <lastBuildDate>Mon, 24 Sep 2018 09:56:09 +0000</lastBuildDate>
<generator>Jekyll v2.5.3</generator>
<item>
Modified: cordova/site/public/plugins/faq.html
URL: http://svn.apache.org/viewvc/cordova/site/public/plugins/faq.html?rev=1841825&r1=1841824&r2=1841825&view=diff
==============================================================================
--- cordova/site/public/plugins/faq.html (original)
+++ cordova/site/public/plugins/faq.html Mon Sep 24 10:20:54 2018
@@ -152,7 +152,7 @@
<h2>I don't like X. How can I help improve the website?</h2>
-<p>You can help improve this site by opening bugs on <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20%3D%20Open%20AND%20component%20%3D%20%22Registry%20Web%22">JIRA</a> or by sending PRs on <a href="https://github.com/apache/cordova-docs/">GitHub</a>.</p>
+<p>You can help improve this site by opening issues or sending PRs on <a href="https://github.com/apache/cordova-docs/">GitHub</a>.</p>
</div>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org