This is an automated email from the ASF dual-hosted git repository.
menardi pushed a commit to branch issues_remove_jira
in repository https://gitbox.apache.org/repos/asf/cordova-docs.git
commit 4e2c7f109dd37c668ec23113e0b3abf9cf7886ab
Author: Gearóid M <mena...@users.noreply.github.com>
AuthorDate: Mon Sep 24 10:18:11 2018 +0900
Update issues documentation to remove JIRA references
---
www/contribute/contribute_guidelines.md | 35 +++++++++++----------------------
www/contribute/issues.md | 25 ++---------------------
www/plugins/faq.md | 2 +-
3 files changed, 14 insertions(+), 48 deletions(-)
diff --git a/www/contribute/contribute_guidelines.md
b/www/contribute/contribute_guidelines.md
index d07c84f..1b4ff36 100644
--- a/www/contribute/contribute_guidelines.md
+++ b/www/contribute/contribute_guidelines.md
@@ -9,44 +9,36 @@ Thanks for helping to improve Cordova! This page provides a
general guide on mak
## Prerequisites
-Before contributing to Apache Cordova, it is recommended that you complete the
following steps:
-
-1. Join the [mailing list](http://cordova.apache.org/contact/) and send a
brief introduction of yourself (optional)
-2. Create an [Apache
JIRA](https://issues.apache.org/jira/secure/Signup!default.jspa) account
+Before contributing to Apache Cordova, it is recommended that you join the
[mailing list](http://cordova.apache.org/contact/) and send a brief
introduction of yourself.
## Working with Issues
-Issues for most Apache Cordova components are hosted in the [Apache
JIRA](https://issues.apache.org/jira/browse/CB). However, some components
instead have their issues on GitHub. If a repository has an _Issues_ 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 [these guidelines](./issues.html).
+Issues for all Apache Cordova components are on
[GitHub](https://github.com/apache/cordova). When reporting issues, please
follow [these guidelines](./issues.html).
#### Claiming Issues
-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 [issues labelled easyfix in
JIRA](https://issues.apache.org/jira/ [...]
-
+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).
## Submitting Code
-You can submit code using one of the following methods:
-
-* Submit a pull request at one of the Apache Github mirrors at
`github.com/apache/<repo name>` (**Strongly Preferred**)
-* Upload patches created with `git format-patch` to the JIRA issue
-* Paste a diff to JIRA (you won't get authorship if you do this)
+You can submit code by submitting a pull request at one of the Apache Github
mirrors at `github.com/apache/<repo name>`.
#### Making Pull requests
The workflow for creating pull requests on Github generally follows these
steps:
-1. [Open an issue](./issues.html) if one has not already been created
(optional if the repository's issues are on GitHub instead of JIRA)
-2. [Create a local fork](https://help.github.com/articles/fork-a-repo/) of the
appropriate Apache repository
+1. [Open an issue](./issues.html) if one has not already been created
(optional)
+2. [Create a local fork](https://help.github.com/articles/fork-a-repo/) of the
appropriate Cordova repository
3. In your local fork, create a branch dedicated to the issue you are working
on
4. Push your commits to this branch
5.
[Squash](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits)
these commits into one single commit (see the section below regarding commit
messages)
-6. [Create a pull
request](https://help.github.com/articles/using-pull-requests/) on the Apache
repository
+6. [Create a pull
request](https://help.github.com/articles/using-pull-requests/) on the Cordova
repository
7. Ask for code review
-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 [Git
documentation](http://git-scm.com/doc).
+Please include the issue ID in the title of any pull requests made to Github.
For more help on Git, see the [Git documentation](http://git-scm.com/doc).
#### Code review
-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 [the component list on
JIRA](https://issues.apache.org/jira/browse/CB/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel)
or you can send a mail out to the [dev mailing
list](http://cordova.apache.org/contact) with a link to the pull request.
+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 [dev mailing
list](http://cordova.apache.org/contact) with a link to the pull request.
## Testing your code
@@ -70,13 +62,8 @@ If possible, please include tests that validate your changes
and catch any futur
## Git Commit Messages
-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:
-```
-CB-2345 android: Improved exec bridge by using strings instead of JSON
-CB-3456 all: Fixed plugin loading paths that start with /
-```
+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 `GH-`, which will
allow GitHub to automatically link issues and PRs.
-If you created an issue on GitHub, the issue number starts with `GH` instead
of `CB`:
```
GH-2345 android: Improved exec bridge by using strings instead of JSON
GH-3456 all: Fixed plugin loading paths that start with /
@@ -85,7 +72,7 @@ GH-3456 all: Fixed plugin loading paths that start with /
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 [...]
```
-CB-1234 Fixed the whizbang widget
+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
diff --git a/www/contribute/issues.md b/www/contribute/issues.md
index f8adc5f..1a8b9db 100644
--- a/www/contribute/issues.md
+++ b/www/contribute/issues.md
@@ -5,10 +5,7 @@ title: Apache Cordova Reporting Issues
# Reporting Issues
-Thank you for helping to improve Cordova! Most issues for Apache Cordova are
currently hosted at the [Apache
JIRA](https://issues.apache.org/jira/browse/CB). However, we are starting to
move issue management to GitHub.
-
-## Should I report an issue on JIRA or GitHub?
-If the repository you are reporting an issue for has an _Issues_ tab on
GitHub, please report it there. Otherwise report it on JIRA.
+Thank you for helping to improve Cordova! All Cordova issues should now be
reported on [GitHub](https://github.com/apache/cordova). Our JIRA issue tracker
has been closed, and new issues can no longer be opened there.
## Creating an issue on GitHub
@@ -19,25 +16,7 @@ Find the repository of the component which your issue
applies to. To figure out
* [cordova-cli](https://github.com/apache/cordova-cli): command-line tool (the
`cordova` command)
* [cordova-docs](https://github.com/apache/cordova-docs): the Cordova website
and documentation
-Once you have found the correct repository to create your issue in, go to the
_Issues_ tab, and click _New issue_. Simply fill out the issue template, and
submit your issue. If there is no _Issues_ tab, please report the issue on JIRA
instead.
-
-## Creating an issue in JIRA
-
-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.
-
-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 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.
-Priority | The impact of the issue (see below)
+Once you have found the correct repository to create your issue in, go to the
_Issues_ tab, and click _New issue_. Simply fill out the issue template, and
submit your issue.
# Issue Priority
diff --git a/www/plugins/faq.md b/www/plugins/faq.md
index c977635..76dc381 100644
--- a/www/plugins/faq.md
+++ b/www/plugins/faq.md
@@ -42,6 +42,6 @@ Yes there are. Please take a look at [Add Plugin Features]({{
site.baseurl }}/do
## I don't like X. How can I help improve the website?
-You can help improve this site by opening bugs on
[JIRA](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20%3D%20Open%20AND%20component%20%3D%20%22Registry%20Web%22)
or by sending PRs on [GitHub](https://github.com/apache/cordova-docs/).
+You can help improve this site by opening issues or sending PRs on
[GitHub](https://github.com/apache/cordova-docs/).
[old_reg]: http://50.17.177.14/
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cordova.apache.org
For additional commands, e-mail: commits-h...@cordova.apache.org
