You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@cordova.apache.org by ja...@apache.org on 2019/02/11 16:35:40 UTC

[cordova-contribute] branch janpio-testing updated (1a26450 -> 5429b6c)

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

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


 discard 1a26450  Testing
     new 52219c3  GitHub Labels (#4)
     new d1681b5  Deprecation and Archiving (#2)
     new 42f7f50  GitHub Project Boards (#7)
     new fd87cea  GitHub Templates: Issue Templates and Pull Request Template (#3)
     new c14671a  Create a minimal reproduction repository or sample (#6)
     new 277852d  Testing
     new 5429b6c  remove notes

This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version.  This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:

 * -- * -- B -- O -- O -- O   (1a26450)
            \
             N -- N -- N   refs/heads/janpio-testing (5429b6c)

You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.

Any revisions marked "omit" are not gone; other references still
refer to them.  Any revisions marked "discard" are gone forever.

The 11 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .github/ISSUE_TEMPLATE.md                  |  38 +++++++++
 .github/ISSUE_TEMPLATE/BUG_REPORT.md       |  38 +++++++++
 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md  |  19 +++++
 .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md |  21 +++++
 .github/PULL_REQUEST_TEMPLATE.md           |  29 +++++++
 README.md                                  |   8 ++
 create-reproduction.md                     |  85 ++++++++++++++++++++
 deprecation.md                             |  86 +++++++++++++++++++++
 github-labels.md                           | 120 +++++++++++++++++++++++++++++
 github-project-boards.md                   |  41 ++++++++++
 github-templates.md                        |  57 ++++++++++++++
 testing-notes                              | 100 ------------------------
 testing-plugins.md                         |  70 -----------------
 13 files changed, 542 insertions(+), 170 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md
 create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
 create mode 100644 .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 create-reproduction.md
 create mode 100644 deprecation.md
 create mode 100644 github-labels.md
 create mode 100644 github-project-boards.md
 create mode 100644 github-templates.md
 delete mode 100644 testing-notes
 delete mode 100644 testing-plugins.md


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

[cordova-contribute] 08/11: GitHub Templates: Issue Templates and Pull Request Template (#3)

Posted by ja...@apache.org.

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

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

commit fd87cea623b54bbc8c2387146181e3dbd70d21f6
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Dec 5 13:54:57 2018 +0100

    GitHub Templates: Issue Templates and Pull Request Template (#3)
    
    This PR adds documentation on GitHub Templates and adds suggested templates.
    
    Its content is the result of this discussion on the mailing list: https://lists.apache.org/thread.html/fe1d0c812b24826bec74ff07e487806a3b5ad8aa1ae882c0294cb6bd@%3Cdev.cordova.apache.org%3E
    
    You can try the issue templates at this repository:
    https://github.com/janpio/cordova-github-templates/issues/new/choose
    https://github.com/janpio/cordova-github-templates/issues/new
    (Pull Request template unfortunately is not that easy, you have to look at the source here)
    
    I don't expect the templates I wrote to match all situations and survive contact with actual users - so please make suggestion on what is missing, could be improved, changed and so on.
    
    Note that whatever we merge here will not be final and those are just text files that will be able to be edited at any time. This is just the starting point.
    
    ---
    
    The section "Distribute GitHub Templates to all repositories" is currently just a TODO, we will have to find a solution for that problem later and describe it via another PR.
    
    ---
    
    Please feel free to nitpick any language and grammar problems - I rewrote this quite often, so it is very possible there are some "organically grown" sentences that could use some polishing.
---
 .github/ISSUE_TEMPLATE.md                  | 38 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/BUG_REPORT.md       | 38 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md  | 19 ++++++++++
 .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md | 21 +++++++++++
 .github/PULL_REQUEST_TEMPLATE.md           | 29 +++++++++++++++
 README.md                                  |  1 +
 github-templates.md                        | 57 ++++++++++++++++++++++++++++++
 7 files changed, 203 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..37ea445
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,38 @@
+<!--
+Please have a look at the issue templates you get when you click "New issue" in the GitHub UI.
+We very much prefer issues created by using one of these templates.
+-->
+
+### Issue Type
+<!-- Please check the boxes by putting an x in the [ ] like so: [x] -->
+
+- [ ] Bug Report
+- [ ] Feature Request
+- [ ] Support Question
+
+## Description
+
+## Information
+<!-- Include all relevant information that might help understand and reproduce the problem -->
+
+### Command or Code
+<!-- What command or code is needed to reproduce the problem? -->
+
+### Environment, Platform, Device
+<!-- In what environment, on what platform or on which device are you experiencing the issue? -->
+
+### Version information
+<!-- 
+What are relevant versions you are using?
+For example:
+Cordova: Cordova CLI, Cordova Platforms, Cordova Plugins 
+Other Frameworks: Ionic Framework and CLI version
+Operating System, Android Studio, Xcode etc.
+-->
+
+## Checklist
+<!-- Please check the boxes by putting an x in the [ ] like so: [x] -->
+
+- [ ] I searched for existing GitHub issues
+- [ ] I updated all Cordova tooling to most recent version
+- [ ] I included all the necessary information above
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md
new file mode 100644
index 0000000..0fc99aa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md
@@ -0,0 +1,38 @@
+---
+name: 🐛 Bug Report
+about: If something isn't working as expected.
+
+---
+
+# Bug Report
+
+## Problem
+
+### What is expected to happen?
+
+### What does actually happen?
+
+## Information
+<!-- Include all relevant information that might help understand and reproduce the problem -->
+
+### Command or Code
+<!-- What command or code is needed to reproduce the problem? -->
+
+### Environment, Platform, Device
+<!-- In what environment, on what platform or on which device are you experiencing the issue? -->
+
+### Version information
+<!-- 
+What are relevant versions you are using?
+For example:
+Cordova: Cordova CLI, Cordova Platforms, Cordova Plugins 
+Other Frameworks: Ionic Framework and CLI version
+Operating System, Android Studio, Xcode etc.
+-->
+
+## Checklist
+<!-- Please check the boxes by putting an x in the [ ] like so: [x] -->
+
+- [ ] I searched for existing GitHub issues
+- [ ] I updated all Cordova tooling to most recent version
+- [ ] I included all the necessary information above
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
new file mode 100644
index 0000000..cabb35f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
@@ -0,0 +1,19 @@
+---
+name: 🚀 Feature Request
+about: A suggestion for a new functionality
+
+---
+
+# Feature Request
+
+## Motivation Behind Feature
+<!-- Why should this feature be implemented? What problem does it solve? -->
+
+## Feature Description
+<!-- Describe your feature request in detail -->
+<!-- Please provide any code examples or screenshots of what this feature would look like -->
+<!-- Are there any drawbacks? Will this break anything for existing users? -->
+
+## Alternatives or Workarounds
+<!-- Describe alternatives or workarounds you are currently using -->
+<!-- Are there ways to do this with existing functionality? -->
diff --git a/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md b/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
new file mode 100644
index 0000000..cf665b3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
@@ -0,0 +1,21 @@
+---
+name: 💬 Support Question
+about: If you have a question, please check out our Slack or StackOverflow!
+
+---
+
+<!------------^ Click "Preview" for a nicer view! -->
+
+Apache Cordova uses GitHub Issues as a feature request and bug tracker _only_.
+For usage and support questions, please check out the resources below. Thanks!
+
+---
+
+* Slack Community Chat: https://cordova.slack.com (you can sign-up at http://slack.cordova.io/)
+* StackOverflow: https://stackoverflow.com/questions/tagged/cordova using the tag `cordova`
+
+If you are using a tools that uses Cordova, like e.g. Ionic, check their support channels:
+
+* Ionic Framework
+  * [Ionic Community Forum](https://forum.ionicframework.com/)
+  * [Ionic Worldwide Slack](https://ionicworldwide.herokuapp.com/)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..3a9a89d
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,29 @@
+<!--
+Please make sure the checklist boxes are all checked before submitting the PR. The checklist
+is intended as a quick reference, for complete details please see our Contributor Guidelines:
+
+http://cordova.apache.org/contribute/contribute_guidelines.html
+
+Thanks!
+-->
+
+### Platforms affected
+
+
+### Motivation and Context
+<!-- Why is this change required? What problem does it solve? -->
+<!-- If it fixes an open issue, please link to the issue here. -->
+
+### Description
+<!-- Describe your changes in detail -->
+
+### Testing
+<!-- Please describe in detail how you tested your changes. -->
+
+### Checklist
+
+- [ ] I've run the tests to see all new and existing tests pass
+- [ ] I added automated test coverage as appropriate for this change.
+- [ ] Commit is prefixed with `(platform)` if this change only applies to one platform (e.g. `(android)`)
+- [ ] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct [keyword to close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
+- [ ] I've updated the documentation if necessary.
diff --git a/README.md b/README.md
index 4d6f8f8..9383b17 100644
--- a/README.md
+++ b/README.md
@@ -12,3 +12,4 @@ This repository contains documents describing everything a contributor of Apache
 
 - [Deprecation and Archiving of Repositories](deprecation.md)
 - [GitHub Labels](github-labels.md)
+- [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

[cordova-contribute] 01/11: empty README

Posted by ja...@apache.org.

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

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

commit 2fb718ffa8e5366639ca37349d0dfaf173d76c85
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 15:04:03 2018 +0200

    empty README
---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0f1321
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+# cordova-contribute
\ No newline at end of file


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

[cordova-contribute] 03/11: fix

Posted by ja...@apache.org.

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

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

commit 5f591f4088d22c4656efa8143e936d769c5e2f36
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 19:11:59 2018 +0200

    fix
---
 README.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 79ac7f6..fbe1e3c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
-# cordova-contribute# cordova-contribute
+# cordova-contribute
 
-This repository contains documents describing everything a contributor of Apache Cordova or Community Member needs know: guidelines, policies, rules, how it's done.
+This repository contains documents describing everything a contributor of Apache Cordova or Community Member needs to know: guidelines, policies, rules, how it's done.
 
 > **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


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

[cordova-contribute] 02/11: short introduction

Posted by ja...@apache.org.

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

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

commit 2b0e944312a3850e27de16d35b2888010e0e6a71
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 18:25:15 2018 +0200

    short introduction
---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f0f1321..79ac7f6 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,5 @@
-# cordova-contribute
\ No newline at end of file
+# cordova-contribute# cordova-contribute
+
+This repository contains documents describing everything a contributor of Apache Cordova or Community Member needs know: guidelines, policies, rules, how it's done.
+
+> **Work in Progress**: This repository is very new and is currently very much "Work in Progress": content is created and added via Pull Requests.


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

[cordova-contribute] 07/11: GitHub Project Boards (#7)

Posted by ja...@apache.org.

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

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

commit 42f7f506ae32ef8c3871d1874cd313bfc64a7e1b
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Dec 5 10:46:08 2018 +0100

    GitHub Project Boards (#7)
    
    * initial description of project boards: PR boards
    
    * add note about note cards
---
 README.md                |  2 ++
 github-project-boards.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)

diff --git a/README.md b/README.md
index 5d6b98c..4d6f8f8 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@ This repository contains documents describing everything a contributor of Apache
 
 ## Topics
 
+- [GitHub Project Boards](github-project-boards.md)
+
 ### Process
 
 - [Deprecation and Archiving of Repositories](deprecation.md)
diff --git a/github-project-boards.md b/github-project-boards.md
new file mode 100644
index 0000000..2bbe978
--- /dev/null
+++ b/github-project-boards.md
@@ -0,0 +1,41 @@
+# GitHub Project Boards
+
+Apache Cordova uses GitHub Project Boards to manage and track both issues and pull requests.
+
+## Release Management
+
+- [Next Release Planning and Tracking](https://github.com/orgs/apache/projects/2?fullscreen=true)
+
+TODO description
+
+## Issue Management
+
+TODO
+
+## Pull Requests Management
+
+For Pull Requests we track their "review and merge progress" on project boards:
+
+- [Platform Pull Requests](https://github.com/orgs/apache/projects/7?fullscreen=true)
+- [Tooling Pull Requests](https://github.com/orgs/apache/projects/8?fullscreen=true)
+- [Plugin Pull Requests (1)](https://github.com/orgs/apache/projects/9?fullscreen=true): camera, file, inappbrowser, media splashscreen
+- [Plugin Pull Requests (2)](https://github.com/orgs/apache/projects/10?fullscreen=true): dialogs, geolocation, media-capture, statusbar, whitelist
+
+### Process
+
+#### Columns
+
+- Pull Requests start in the "New PR / Untriaged" column (added manually by using the "Add Card" functionality) 
+- They can then be sorted by a maintainer into columns according to their "review" readiness ("Blocked: Work in Progress", "Blocked: Conflict", "Blocked: Tests failing" or "Ready for Review").  
+- On review, merge, close etc. they are moved to other columns by automation ("Pending Approval", "Approved, waiting for Merge", "Merged, waiting for Release", "Closed/Abandoned").  
+- After release they are manually moved to the "Released" column.
+
+#### Labels
+
+[GitHub Labels](github-labels.md) for platform (`platform: ios`, `platform: android`) and type (`bug`, `feature`, `enhancement`) are used to categorize pull requests.
+
+#### Notes
+
+"Note cards" (in contrast to issue or pull request cards) are used to highlight quirks of a board (e.g. that there are multipple plugin PR boards because of the 5 associated repositories limit by GitHub) and the "automation type" for reach column (human, automation, both).
+
+


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

[cordova-contribute] 06/11: Deprecation and Archiving (#2)

Posted by ja...@apache.org.

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

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

commit d1681b5bed9f045bd869c05e8debf2f54f3288a4
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Tue Dec 4 15:10:09 2018 +0100

    Deprecation and Archiving (#2)
    
    This PR explains the process "Deprecation and Archiving" of repositories.
    
    Its content is the result of this discussion on the mailing list: https://lists.apache.org/thread.html/34369ada22f8a616e90471d38c8fd7def2eb17ff3ddbf4ba0b47987f@%3Cdev.cordova.apache.org%3E
    
    It refers to the Deprecation Policy page from https://github.com/apache/cordova-docs/pull/878 in multiple places.
    
    Please feel free to nitpick any language and grammar problems - I rewrote this quite often, so it is very possible there are some "organically grown" sentences.
    
    Please have a special look at the text templates: notice template and issue/PR closing message.
---
 README.md      |  1 +
 deprecation.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 87 insertions(+)

diff --git a/README.md b/README.md
index 115f773..5d6b98c 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,5 @@ This repository contains documents describing everything a contributor of Apache
 
 ### Process
 
+- [Deprecation and Archiving of Repositories](deprecation.md)
 - [GitHub Labels](github-labels.md)
diff --git a/deprecation.md b/deprecation.md
new file mode 100644
index 0000000..f851640
--- /dev/null
+++ b/deprecation.md
@@ -0,0 +1,86 @@
+# Deprecation and Archiving
+
+[Apache Cordova's Deprecation Policy](https://cordova.apache.org/deprecation_policy.html) defines why, when and how Cordova projects are deprecated and archived. These are the steps to be taken by a contributor to "execute" such an deprecation:
+
+## Deprecating or Archiving a Repository
+
+
+### 1. Vote
+
+Similar to other important decisions, Apache Cordova uses a [voting process](https://www.apache.org/foundation/how-it-works.html#decision-making) on deprecations and archiving of components. If you intend to deprecate or archive a component or repository, send an email to the [appropriate mailing list](https://cordova.apache.org/contact/) describing the intended action and start a vote on it.  
+
+Only proceed if the vote succeeds.
+
+### 2. Document deprecation in [`deprecated.md` of `apache/cordova`](https://github.com/apache/cordova/blob/master/deprecated.md)
+
+Document the deprecation of the component in [`deprecated.md` of `apache/cordova`](https://github.com/apache/cordova/blob/master/deprecated.md). You can include information as the the reason for deprecation, a link to the deprecation announcement, links to vital forks, alternatives etc.
+
+### 3. Make changes in `README.md`
+
+Add the [Deprecation Notice Template](#deprecation-notice) to the `README.md` of the project. Make sure the template is adapted to the specific component as described.
+
+### 4. Archiving only: Close Issues and Pull Requests
+
+As archiving will make Issues and Pull Requests read only, it is common and [suggested by GitHub](https://help.github.com/articles/about-archiving-repositories/) to clean up issues and pull requests before archiving a repository. If there are open issues or PRs with the component's repository, please close them with the [suggested Issue and Pull Request closing text](#suggested-issue-and-pull-request-closing-text) or similar. 
+
+### 5. Request GitHub repository changes from Apache INFRA
+
+A PMC member has to [open an issue with Apache INFRA](https://issues.apache.org/jira/browse/INFRA) to request changes to a GitHub repository.
+
+For deprecation:
+
+1. Make sure the deprecation notice is in `README.md` and contains all information.
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that the repository description is prefixed with `[DEPRECATED] `.
+
+For archiving:
+
+1. Make sure the deprecation notice is in `README.md` and contains all information.
+1. Make sure there are no more open Issues and Pull Requests for this repository.
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that   
+  a) the repository description is prefixed with `[DEPRECATED] ` and   
+  b) the repository is archived on GitHub.
+
+### 6. Announce
+
+Announce the successful execution of all deprecation and/or archiving actions to your fellow Apache Cordova PMC members and developers on the [appropriate mailing list](https://cordova.apache.org/contact/). Thanks!
+
+
+## Templates
+
+### Deprecation Notice
+
+This template is to be used in the `README.md` of depreacted components. The "Learn more" link should be customized to link to the corresponding headline in [`deprecated.md` of `apache/cordova`](https://github.com/apache/cordova/blob/master/deprecated.md) (replace `xyz` with the correct link anchor).
+
+---
+📌 **Deprecation Notice**
+
+This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is but any future issues will not be fixed by the Cordova community.
+
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
+
+- Learn more: https://github.com/apache/cordova/blob/master/deprecated.md#xyz
+---
+
+#### Markdown
+
+```markdown
+---
+📌 **Deprecation Notice**
+
+This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is but any future issues will not be fixed by the Cordova community.
+
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
+
+- Learn more: https://github.com/apache/cordova/blob/master/deprecated.md#xyz
+---
+```
+
+### Suggested Issue and Pull Request closing text
+
+We are archiving this repository following [Apache Cordova's Deprecation Policy](https://cordova.apache.org/deprecation_policy.html). We will not continue to work on this repository. Therefore all issues and pull requests are being closed. Thanks for your contribution.
+
+#### Markdown
+
+```markdown
+We are archiving this repository following [Apache Cordova's Deprecation Policy](https://cordova.apache.org/deprecation_policy.html). We will not continue to work on this repository. Therefore all issues and pull requests are being closed. Thanks for your contribution.
+```


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

[cordova-contribute] 11/11: remove notes

Posted by ja...@apache.org.

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

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

commit 5429b6c37f4fca7388642909c16717364ba6ae9d
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Mon Feb 11 17:35:22 2019 +0100

    remove notes
---
 testing-notes      | 100 -----------------------------------------------------
 testing-plugins.md |  70 -------------------------------------
 2 files changed, 170 deletions(-)

diff --git a/testing-notes b/testing-notes
deleted file mode 100644
index c39e736..0000000
--- a/testing-notes
+++ /dev/null
@@ -1,100 +0,0 @@
-#### https://github.com/apache/cordova-android
-
-https://github.com/apache/cordova-android/blob/ef2434188efeef868e91232188ef080acdd28e32/package.json#L21-L30
-```
-  "scripts": {
-    "test": "run-s eslint unit-tests java-unit-tests e2e-tests",
-    "eslint": "run-s -c eslint:*",
-    "eslint:scripts": "eslint bin spec test",
-    "eslint:bins": "eslint 'bin/**/*' --ignore-pattern '**/*.*' --ignore-pattern '**/gitignore' --ignore-pattern 'bin/templates/cordova/version'"
-    "unit-tests": "jasmine --config=spec/unit/jasmine.json",
-    "java-unit-tests": "node test/run_java_unit_tests.js",
-    "e2e-tests": "jasmine --config=spec/e2e/jasmine.json",
-    "cover": "istanbul cover --root bin --print detail jasmine -- --config=spec/unit/jasmine.json",
-},
-```
-AppVeyor: npm test
-Travis:     - npm test
-- npm run cover
-
-
-
-
-
-#### https://github.com/apache/cordova-ios
-
-https://github.com/apache/cordova-ios/blob/62ebfbd74aff11b9fa0ca26685ee0578ecd9150f/package.json#L20-L32
-```
-  "scripts": {
-    "test": "npm run unit-tests && npm run test:component && npm run objc-tests && npm run e2e-tests",
-
-    "unit-tests": "jasmine --config=tests/spec/unit.json",
-    "test:component": "jasmine --config=tests/spec/component.json",
-    "objc-tests": "npm run objc-tests-lib && npm run objc-tests-framework",
-      "objc-tests-lib": "xcodebuild test -workspace tests/cordova-ios.xcworkspace -scheme CordovaLibTests -destination \"platform=iOS Simulator,name=iPhone 8\" CONFIGURATION_BUILD_DIR=\"`mktemp -d 2>/dev/null || mktemp -d -t 'cordova-ios'`\"",
-      "objc-tests-framework": "xcodebuild test -workspace tests/cordova-ios.xcworkspace -scheme CordovaFrameworkApp -destination \"platform=iOS Simulator,name=iPhone 8\" CONFIGURATION_BUILD_DIR=\"`mktemp -d 2>/dev/null || mktemp -d -t 'cordova-ios'`\"",
-    "e2e-tests": "jasmine tests/spec/create.spec.js",
-
-    "posttest": "npm run eslint",
-    "eslint": "eslint bin tests"
-
-    "cover": "nyc jasmine --config=tests/spec/coverage.json",
-
-    "preobjc-tests": "tests/scripts/killsim.js",
-},
-```
-AppVeyor:   - npm run unit-tests
-- npm run eslint
-Travis:   - npm run eslint
-  - npm run unit-tests
-  - npm run test:component
-  - npm run e2e-tests
-  - open -b com.apple.iphonesimulator
-  - npm run objc-tests
-- npm run cover
-https://github.com/apache/cordova-ios/blob/62ebfbd74aff11b9fa0ca26685ee0578ecd9150f/.travis.yml#L22-L28
-
-#### https://github.com/apache/cordova-windows
-
-https://github.com/apache/cordova-windows/blob/f687f6a58bcad5893039af991921cab4dae5bdcc/package.json#L19-L25
-```
-  "scripts": {
-    "test": "npm run eslint && npm run test-unit && npm run test-e2e",
-    "test-unit": "jasmine",
-    "test-e2e": "jasmine spec/e2e/endtoend.spec.js",
-    "cover": "istanbul cover --root bin/templates/cordova --print detail jasmine",
-    "eslint": "eslint bin && eslint template && eslint spec"
-},
-```
-AppVeyor: npm test
-Travis:   - npm run eslint
-- npm run cover
-
-#### https://github.com/apache/cordova-browser
-
-https://github.com/apache/cordova-browser/blob/59690b4f9a8bd47887f61c81aa6a6aba9962dade/package.json#L19-L23
-```
-  "scripts": {
-    "eslint": "eslint bin && eslint spec",
-    "jasmine": "jasmine",
-    "test": "npm run eslint && npm run jasmine"
-},
-```
-- AppVeyor: npm test
-- Travis: npm test
-
-#### https://github.com/apache/cordova-osx
-
-https://github.com/apache/cordova-osx/blob/8a70ced07351688c75ed09c9fe77eeb9a3dc7f16/package.json#L17-L23
-
-```
-  "scripts": {
-    "test": "npm run eslint && npm run test:coverage",
-    "test:objc": "jasmine  --config=tests/spec/objc.json",
-    "test:component": "jasmine --config=tests/spec/component.json",
-    "test:coverage": "nyc jasmine --config=tests/spec/coverage.json",
-    "eslint": "eslint bin tests"
-},
-```
-AppVeyor: -
-Tracis: npm test
diff --git a/testing-plugins.md b/testing-plugins.md
deleted file mode 100644
index 44a2c00..0000000
--- a/testing-plugins.md
+++ /dev/null
@@ -1,70 +0,0 @@
-# Testing Cordova Plugins
-
-## Writing tests
-
-### Unit Tests
-
-
-jasmine
-
-### Integration Tests
-
-1. `/tests` in app
-2. https://github.com/apache/cordova-plugin-test-framework
-3. `cdvtests/index.html`
-
-
-Install plugin and its tests in an app:
-
-```
-cordova plugin add https://github.com/apache/cordova-plugin-file-transfer.git
-cordova plugin add plugins/cordova-plugin-file-transfer/tests # local tests that were downloaded with previous commands
-cordova plugin add https://github.com/apache/cordova-plugin-test-framework
-```
-
-
-
-
-
-
-
-
-## Manual
-
-
-
-## Automated
-
-eslint
-paramedic
-  appium tests
-
-### CI
-
-Continuous Integration of Cordova plugins uses multiple providers:
-
-- Travis for Linux
-- AppVeyor for Windows
-
-There is no (or: only sometimes) direct testing on macOS (on Travis).
-
-#### Sauce Labs
-
-But integration tests are run on Saucelabs on many different devices, emulators and browsers (Android, iOS, Firefox, Safari, Chrome etc.). 
-
-The tests are executed via Travis, which triggers `cordova-paramedic`.  
-The tests are written in Appium.  
-The list of platforms to test is configured in `.travis.yml`.  
-The paramedic command is triggered after running all other tests.
-
-##### Credentials
-
-Account `snay`
-
-```yaml
-addons:
-  jwt:
-    secure: QivPLlqTVvOo3TJeHxuBOfxU6lho1I0IxQ3b68yntkEQQJko6kzleXHfgjf0a8aw8m38E3+fxaBWF1bGyucGwOLDWY8Ddt2P2xg44zdXH5EXHd9oIqAgngIdzLvUtH3Db2TbQEtIGOkrnNR2STovjqB7vHGLASQrgs4oL7r32/s=
-```
-
-encrypted SAUCE_ACCESS_KEY with https://docs.travis-ci.com/user/jwt


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

[cordova-contribute] 10/11: Testing

Posted by ja...@apache.org.

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

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

commit 277852d0819f799afca53e0c1447a0ad4633c269
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Nov 28 12:17:36 2018 +0100

    Testing
---
 testing-notes      | 100 +++++++++++++++++++++++++++
 testing-plugins.md |  70 +++++++++++++++++++
 testing.md         | 196 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 366 insertions(+)

diff --git a/testing-notes b/testing-notes
new file mode 100644
index 0000000..c39e736
--- /dev/null
+++ b/testing-notes
@@ -0,0 +1,100 @@
+#### https://github.com/apache/cordova-android
+
+https://github.com/apache/cordova-android/blob/ef2434188efeef868e91232188ef080acdd28e32/package.json#L21-L30
+```
+  "scripts": {
+    "test": "run-s eslint unit-tests java-unit-tests e2e-tests",
+    "eslint": "run-s -c eslint:*",
+    "eslint:scripts": "eslint bin spec test",
+    "eslint:bins": "eslint 'bin/**/*' --ignore-pattern '**/*.*' --ignore-pattern '**/gitignore' --ignore-pattern 'bin/templates/cordova/version'"
+    "unit-tests": "jasmine --config=spec/unit/jasmine.json",
+    "java-unit-tests": "node test/run_java_unit_tests.js",
+    "e2e-tests": "jasmine --config=spec/e2e/jasmine.json",
+    "cover": "istanbul cover --root bin --print detail jasmine -- --config=spec/unit/jasmine.json",
+},
+```
+AppVeyor: npm test
+Travis:     - npm test
+- npm run cover
+
+
+
+
+
+#### https://github.com/apache/cordova-ios
+
+https://github.com/apache/cordova-ios/blob/62ebfbd74aff11b9fa0ca26685ee0578ecd9150f/package.json#L20-L32
+```
+  "scripts": {
+    "test": "npm run unit-tests && npm run test:component && npm run objc-tests && npm run e2e-tests",
+
+    "unit-tests": "jasmine --config=tests/spec/unit.json",
+    "test:component": "jasmine --config=tests/spec/component.json",
+    "objc-tests": "npm run objc-tests-lib && npm run objc-tests-framework",
+      "objc-tests-lib": "xcodebuild test -workspace tests/cordova-ios.xcworkspace -scheme CordovaLibTests -destination \"platform=iOS Simulator,name=iPhone 8\" CONFIGURATION_BUILD_DIR=\"`mktemp -d 2>/dev/null || mktemp -d -t 'cordova-ios'`\"",
+      "objc-tests-framework": "xcodebuild test -workspace tests/cordova-ios.xcworkspace -scheme CordovaFrameworkApp -destination \"platform=iOS Simulator,name=iPhone 8\" CONFIGURATION_BUILD_DIR=\"`mktemp -d 2>/dev/null || mktemp -d -t 'cordova-ios'`\"",
+    "e2e-tests": "jasmine tests/spec/create.spec.js",
+
+    "posttest": "npm run eslint",
+    "eslint": "eslint bin tests"
+
+    "cover": "nyc jasmine --config=tests/spec/coverage.json",
+
+    "preobjc-tests": "tests/scripts/killsim.js",
+},
+```
+AppVeyor:   - npm run unit-tests
+- npm run eslint
+Travis:   - npm run eslint
+  - npm run unit-tests
+  - npm run test:component
+  - npm run e2e-tests
+  - open -b com.apple.iphonesimulator
+  - npm run objc-tests
+- npm run cover
+https://github.com/apache/cordova-ios/blob/62ebfbd74aff11b9fa0ca26685ee0578ecd9150f/.travis.yml#L22-L28
+
+#### https://github.com/apache/cordova-windows
+
+https://github.com/apache/cordova-windows/blob/f687f6a58bcad5893039af991921cab4dae5bdcc/package.json#L19-L25
+```
+  "scripts": {
+    "test": "npm run eslint && npm run test-unit && npm run test-e2e",
+    "test-unit": "jasmine",
+    "test-e2e": "jasmine spec/e2e/endtoend.spec.js",
+    "cover": "istanbul cover --root bin/templates/cordova --print detail jasmine",
+    "eslint": "eslint bin && eslint template && eslint spec"
+},
+```
+AppVeyor: npm test
+Travis:   - npm run eslint
+- npm run cover
+
+#### https://github.com/apache/cordova-browser
+
+https://github.com/apache/cordova-browser/blob/59690b4f9a8bd47887f61c81aa6a6aba9962dade/package.json#L19-L23
+```
+  "scripts": {
+    "eslint": "eslint bin && eslint spec",
+    "jasmine": "jasmine",
+    "test": "npm run eslint && npm run jasmine"
+},
+```
+- AppVeyor: npm test
+- Travis: npm test
+
+#### https://github.com/apache/cordova-osx
+
+https://github.com/apache/cordova-osx/blob/8a70ced07351688c75ed09c9fe77eeb9a3dc7f16/package.json#L17-L23
+
+```
+  "scripts": {
+    "test": "npm run eslint && npm run test:coverage",
+    "test:objc": "jasmine  --config=tests/spec/objc.json",
+    "test:component": "jasmine --config=tests/spec/component.json",
+    "test:coverage": "nyc jasmine --config=tests/spec/coverage.json",
+    "eslint": "eslint bin tests"
+},
+```
+AppVeyor: -
+Tracis: npm test
diff --git a/testing-plugins.md b/testing-plugins.md
new file mode 100644
index 0000000..44a2c00
--- /dev/null
+++ b/testing-plugins.md
@@ -0,0 +1,70 @@
+# Testing Cordova Plugins
+
+## Writing tests
+
+### Unit Tests
+
+
+jasmine
+
+### Integration Tests
+
+1. `/tests` in app
+2. https://github.com/apache/cordova-plugin-test-framework
+3. `cdvtests/index.html`
+
+
+Install plugin and its tests in an app:
+
+```
+cordova plugin add https://github.com/apache/cordova-plugin-file-transfer.git
+cordova plugin add plugins/cordova-plugin-file-transfer/tests # local tests that were downloaded with previous commands
+cordova plugin add https://github.com/apache/cordova-plugin-test-framework
+```
+
+
+
+
+
+
+
+
+## Manual
+
+
+
+## Automated
+
+eslint
+paramedic
+  appium tests
+
+### CI
+
+Continuous Integration of Cordova plugins uses multiple providers:
+
+- Travis for Linux
+- AppVeyor for Windows
+
+There is no (or: only sometimes) direct testing on macOS (on Travis).
+
+#### Sauce Labs
+
+But integration tests are run on Saucelabs on many different devices, emulators and browsers (Android, iOS, Firefox, Safari, Chrome etc.). 
+
+The tests are executed via Travis, which triggers `cordova-paramedic`.  
+The tests are written in Appium.  
+The list of platforms to test is configured in `.travis.yml`.  
+The paramedic command is triggered after running all other tests.
+
+##### Credentials
+
+Account `snay`
+
+```yaml
+addons:
+  jwt:
+    secure: QivPLlqTVvOo3TJeHxuBOfxU6lho1I0IxQ3b68yntkEQQJko6kzleXHfgjf0a8aw8m38E3+fxaBWF1bGyucGwOLDWY8Ddt2P2xg44zdXH5EXHd9oIqAgngIdzLvUtH3Db2TbQEtIGOkrnNR2STovjqB7vHGLASQrgs4oL7r32/s=
+```
+
+encrypted SAUCE_ACCESS_KEY with https://docs.travis-ci.com/user/jwt
diff --git a/testing.md b/testing.md
new file mode 100644
index 0000000..d281b2d
--- /dev/null
+++ b/testing.md
@@ -0,0 +1,196 @@
+# Testing Cordova
+
+The aim of Cordova's developer team is to produce great and working software. To achieve this, we invested a lot of time into making Cordova testable. This document should give a general overview about our testing practices and setup.
+
+## Table of Contents
+
+- [What is the current state of the tests?](#what-is-the-current-state-of-the-tests-)
+- [What types of tests does Cordova use?](#what-types-of-tests-does-cordova-use-)
+  * [Manual Tests](#manual-tests)
+  * [Automated Tests](#automated-tests)
+    + [Syntax Checker](#syntax-checker)
+    + [Unit Tests](#unit-tests)
+      - [Code Coverage](#code-coverage)
+    + [Component Tests](#component-tests)
+    + [Integration / End to End Tests](#integration---end-to-end-tests)
+      - [Appium](#appium-interface-tests)
+- [How to implement tests?](#how-to-implement-tests-)
+  * [Tooling](#tooling)
+  * [Platforms](#platforms)
+    + [Native Unit Tests](#native-unit-tests)
+  * [Plugins](#plugins)
+    + [Plugin tests with `cordova-plugin-test-framework`](#plugin-tests-with--cordova-plugin-test-framework-)
+    + [Appium Tests](#appium-tests)
+    + [Paramedic: `cordova-paramedic`](#paramedic---cordova-paramedic-)
+      - [Sauce Labs](#sauce-labs)
+    + [Core Plugins](#core-plugins)
+    + [3rd party plugins](#3rd-party-plugins)
+- [How to run tests?](#how-to-run-tests-)
+  * [Local](#local)
+    + [Special case: Plugins](#special-case--plugins)
+  * [Continuous Integration](#continuous-integration)
+
+<!--<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>-->
+
+## What is the current state of the tests?
+
+If you are only interested in the [current build status](#continuous-integration) of the repositories and [how much of the code is covered by tests](#code-coverage) you can check our [Cordova Status Dashboard](https://apache.github.io/cordova-status/). It shows badges for each CI provider that indicate the current build status and a badge that contains the % of code coverage for each repository. Click each badge for more information.
+
+If you are interested in how all this works, please read on:
+
+## What types of tests does Cordova use?
+
+Cordova projects use several different types of tests:
+
+### Manual Tests
+
+- Check if some manual action produces the expected result.
+- Manual tests are often not explicitly documented, but implicitly assumed. If there is an actual implementation, it is much more "free form" as with the other test types mentioned on this page: E.g. for [plugins](#plugins), manual tests are defined as a list of buttons to tap and an "Expected result" text below the button.
+
+### Automated Tests
+
+#### Syntax Checker
+
+- Check if the code of a project follows specific syntax guidelines.  
+- Usually uses [`eslint`](https://eslint.org/), which is "a fully pluggable tool for identifying and reporting on patterns in JavaScript".
+
+#### Unit Tests
+
+- Check if individual pieces of code produce the expected results.
+- All Cordova projects use [`jasmine`](https://jasmine.github.io/) to write and run **unit tests** for their JavaScript code: "Jasmine is a behavior-driven development framework for testing JavaScript code."
+- For their native code some projects use the appropriate tools of the platform to run tests: e.g. `gradle` for running Android JUnit tests, `xcodebuild test` for running [iOS XCTests](https://developer.apple.com/documentation/xctest)
+
+##### Code Coverage
+
+- Check how much of the code base is covered by the previously run Unit Tests.
+- Some Cordova projects (see the Codecov badges [here](https://github.com/apache/cordova-status)) collect code coverage by using [`nyc`](https://github.com/istanbuljs/nyc) (e.g. `cordova-android`, `cordova-android`) and report the results to [Codecov](https://codecov.io/) for tracking and visualization.
+
+#### Component Tests
+
+- Check if an individual piece of code, interacting with an external component, produces the expected results.
+- Component tests are used in a few places, and are also written with `jasmine`.
+
+#### Integration / End to End Tests
+
+- Check if multiple pieces of code or software work together as expected.
+- `jasmine` is also used to write and execute end to end tests.
+
+##### Appium Interface Tests
+
+- Check the app behavior by simulating actual user input.
+- Appium tests also use `jasmine` syntax for the general testing setup, but the [Webdriver API](https://www.w3.org/TR/webdriver1/) to simulate and drive interactions with the app on the device.
+<!-- TODO Means that the native code is being exercised. -->
+
+## How to implement tests?
+
+### Tooling
+
+TODO
+
+### Platforms
+
+TODO `/spec`
+
+#### Native Unit Tests
+
+Additionally to the usual unit tests explained above, for the platforms there can also be **native unit tests**. Those usually live in `/test(s)` and come in the form of a native test project that interacts with the main platform code. They can also be run via a `npm run ...` command that triggers a Javascript file in the test directory.
+
+For Android for example:
+- https://github.com/apache/cordova-android/blob/master/test/
+- https://github.com/apache/cordova-android/blob/master/test/run_java_unit_tests.js
+- `npm run java-unit-tests`
+
+### Plugins
+
+Plugin tests are somewhat special, as they are set up in a different way. `npm run tests` just includes the syntax check, while the real tests are run by other means:
+
+#### Native
+
+https://github.com/apache/cordova-plugin-camera/tree/master/tests/ios
+https://github.com/apache/cordova-plugin-splashscreen/tree/master/tests/ios
+https://github.com/apache/cordova-plugin-wkwebview-engine/tree/master/tests/ios
+
+#### Plugin tests with `cordova-plugin-test-framework`
+
+The actual tests can be found as `test.js` in a `/tests` folder. The automated tests, exported as `defineAutoTests`, use the familiar `jasmine` syntax, while the manual tests can be any HTML elements - usually buttons that trigger a JS function, with a description of the expected result underneath - exported via `defineManualTests`.
+
+Additionally, the `/tests` folder contains its own `package.json` and `config.xml` to create a "mini test plugin" to be used by [`cordova-plugin-test-framework`](https://github.com/apache/cordova-plugin-test-framework) to create a test interface (manual UI and `jasmine` test runner) that is viewable inside an app: Create a new app, add the plugin, add the "tests" sub-plugin and you can navigate to `cdvtests/index.html` in your app to view that test interface.
+
+#### Appium Tests
+
+A small number of plugins also implements End to End Tests with Appium. They live in `/appium-tests`.
+TODO Native code is being execised vs. JS part with all the other test types
+
+#### Paramedic: `cordova-paramedic`
+
+To automate the creating of a test app and the test execution process [`cordova-paramedic`](https://github.com/apache/cordova-paramedic) can be be used:
+
+1. Install `cordova-paramedic` (`npm install -g ...` or clone + `npm install`)
+2. Run Paramedic for the current plugin:  
+    ```
+    node /tmp/paramedic/main.js 
+      --config pr/$PLATFORM 
+      --plugin $(pwd) 
+    ```
+3. App is built, setup; Tests are run and results reported
+
+##### Sauce Labs
+
+Paramedic can also run these tests on a remote service called Sauce Labs. They offer emulators and real devices of all kind to run testing on. Both normal plugin tests and Appium tests are executed on Sauce Labs on different operating systems and operating system versions.
+
+#### Core Plugins
+
+(Almost) All Core Plugins implement tests in the previously described ways. Some focus on automated tests, some on manual ones. The plugin tests are executed on CI by the already mentioned `cordova-paramedic` on Sauce Labs.
+
+#### 3rd party plugins
+
+TODO
+
+Some have tests, not very many unfortunately.
+
+
+## How to run tests?
+
+### Local
+
+As all Cordova projects are set up as JavaScript projects, the available test commands are usually defined in the `scripts` array of `package.json`. An example from `cordova-android`:
+
+```json
+  "scripts": {
+    "test": "run-s eslint unit-tests java-unit-tests e2e-tests",
+    "eslint": "run-s -c eslint:*",
+    "eslint:scripts": "eslint bin spec test",
+    "eslint:bins": "eslint 'bin/**/*' --ignore-pattern '**/*.*' --ignore-pattern '**/gitignore' --ignore-pattern 'bin/templates/cordova/version'"
+    "unit-tests": "jasmine --config=spec/unit/jasmine.json",
+    "java-unit-tests": "node test/run_java_unit_tests.js",
+    "e2e-tests": "jasmine --config=spec/e2e/jasmine.json",
+    "cover": "istanbul cover --root bin --print detail jasmine -- --config=spec/unit/jasmine.json",
+  },
+```
+
+This defines different keywords that can be used for `npm run ...`, i.e. `npm run test`. In this case `test` is a combination of sub-commands, that can also be run individually.
+
+Contributors are expected to use those commands before, during and after making changes to the codebase to ensure that the tests still pass.
+
+#### Special case: Plugins
+
+As plugin tests are implemented in a special way, read [how to implement and run plugin tests below](#plugins).
+
+### Continuous Integration
+
+The same npm scripts are also used in CI environments to run tests. Each CI service in use usually has a configuration file in the repository under test, e.g. `.travis.yml` for Travis CI. These configuration files define the setup and commands to run on each build, which usually includes `npm run test` or similar commands to run these tests.
+
+<!--
+
+## Missing bits
+
+- Proper integration tests of CLI and platforms
+- Testing installation of 3rd party plugins
+- Testing installation of core plugins
+
+
+#### Command line
+#### Emulators or Devices
+#### Remote Emulators or Devices
+
+-->
\ No newline at end of file


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

[cordova-contribute] 05/11: GitHub Labels (#4)

Posted by ja...@apache.org.

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

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

commit 52219c3a9d0cee2ec3f0e58c8fcfd52166237386
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Fri Sep 28 19:59:55 2018 +0200

    GitHub Labels (#4)
    
    * GitHub Labels
    
    * fix subhead
    
    * try to fix color
    
    * test color
    
    * color via placeholder images
    
    * fix invalid color
---
 README.md        |   3 ++
 github-labels.md | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 123 insertions(+)

diff --git a/README.md b/README.md
index f56ff10..115f773 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,6 @@ This repository contains documents describing everything a contributor of Apache
 
 ## Topics
 
+### Process
+
+- [GitHub Labels](github-labels.md)
diff --git a/github-labels.md b/github-labels.md
new file mode 100644
index 0000000..567e3ca
--- /dev/null
+++ b/github-labels.md
@@ -0,0 +1,120 @@
+# GitHub Labels
+
+Apache Cordova uses [Github Issues](github-issues.md) for issue tracking and [GitHub Pull Requests](github-pull-requests.md) for code changes and contributions. Issues and Pull Requests use [labels](https://help.github.com/articles/about-labels/) for organization and categorization.
+
+Cordova does _not_ use labels for version, milestone or release tracking. [GitHub Milestones](github-milestones.md) are used for that.
+
+## Apache Cordova GitHub Labels
+
+The following defines the label names, label description and label color in use:
+
+### Default labels
+
+The [default labels](https://help.github.com/articles/about-labels/#using-default-labels) created with new repositories offer a good baseline:
+
+- ![#f03c15](https://placehold.it/20/d73a4a/000000?text=+) `bug`: Something isn't working
+- ![#cfd3d7](https://placehold.it/20/cfd3d7/000000?text=+) `duplicate`: This issue or pull request already exists
+- ![#a2eeef](https://placehold.it/20/a2eeef/000000?text=+) `enhancement`: ~~New feature or request~~ Changes to existing code
+- ![#7057ff](https://placehold.it/20/7057ff/000000?text=+) `good first issue`: Good for newcomers
+- ![#008672](https://placehold.it/20/008672/000000?text=+) `help wanted`: Extra attention is needed
+- ![#e4e669](https://placehold.it/20/e4e669/000000?text=+) `invalid`: This doesn't seem right
+- ![#d876e3](https://placehold.it/20/d876e3/000000?text=+) `question`: Further information is requested
+- ![#ffffff](https://placehold.it/20/ffffff/000000?text=+) `wontfix`: This will not be worked on
+
+The label names `good first issue` and `help wanted` have [special meaning](https://help.github.com/articles/helping-new-contributors-find-your-project-with-labels/) on GitHub.
+
+#### Changes to default labels
+
+The list above has some ~~strike through~~ text. These are our changes to the default labels, so they don't clash with out custom labels below.
+
+### Custom labels
+
+- ![#0e8a16](https://placehold.it/20/0e8a16/000000?text=+) `feature`: New functionality that requires new code
+- ![#1d76db](https://placehold.it/20/1d76db/000000?text=+) `discussion`: Creator is open to suggestions or wants to discuss how something should be implemented
+- ![#ccc](https://placehold.it/20/ccc/000000?text=+) `support`: Support questions that want to understand how something works, need help debugging their individual problem etc. are closed and tagged with this label.
+
+#### Plugin repositories
+
+For plugin repositories it makes sense to categorize Issues - e.g. a bug report or feature request - or Pull Requests by its platform:
+
+- ![#c5def5](https://placehold.it/20/c5def5/000000?text=+) `platform: ios`
+- ![#c2e0c6](https://placehold.it/20/c2e0c6/000000?text=+) `platform: android`
+- ![#fef2c0](https://placehold.it/20/fef2c0/000000?text=+) `platform: browser`
+- ![#d4c5f9](https://placehold.it/20/d4c5f9/000000?text=+) `platform: windows`
+
+<!--
+### Possible future labels
+
+A collection of labels that might be useful for Cordova in the future, with e.g. some automation in place:
+
+```
+waiting-for-information: Requested more information from user and waiting for reply.
+confirmed: To indicate a bug has been replicated and a PR fixing the problem should be created.
+has-pr: Issues that already have a PR that is waiting to get reviewed/merged/released.
+work-in-progress: Someone is currently working on this Pull Request.
+
+triage
+needs investigation
+needs info
+needs reply 
+cannot reproduce 
+
+status: auto-closed
+status: waiting-for-reply
+status: needs-attention
+status: on-hold
+status: blocked
+
+status: included-in-next-release
+status: released
+
+type: code-improvement
+type: documentation
+
+effort: low
+effort: moderate
+effort: high
+
+priority: low
+priority: high
+
+P4: nice to have
+P3: important
+P2: required
+P1: urgent
+P0: critical
+```
+
+-->
+
+## Distribute GitHub Labels to multiple repositories
+
+TODO
+<!--
+Pseudocode:
+Go through all repositories
+  Go through list of label definitions
+    If label already exists
+      Update description and color
+      # This is important as the color and descriptions mentioned above are pretty new, so most of Cordova's repositories are configured with an older color set and without descriptions.
+    If label does not exist
+      Create label with description and color
+  If labels exist that are not part of label definitions
+    Output details for manual handling
+      - name, description, color
+      - number of issues
+
+Existing Alternatives:
+- http://www.dorukdestan.com/github-label-manager/ 
+  - https://medium.com/@dtinth/how-to-copy-github-labels-from-one-project-to-another-1857adc73e0f
+  - terrible security practices as basic auth is used
+- https://github.com/HewlettPackard/yoda/blob/master/docs/MANUAL.md#label-manager
+  https://hewlettpackard.github.io/yoda/yoda-label-manager.html
+- https://gist.github.com/symm/ba69f2b715558c61b1a2 
+  - Could be used for a simple PHP script
+- https://github.com/BlueAcornInc/github-label-manager
+  uses https://github.com/jasonbellamy/git-label
+- https://github.com/himynameisdave/git-labelmaker
+  uses https://github.com/jasonbellamy/git-label
+
+-->


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

[cordova-contribute] 09/11: Create a minimal reproduction repository or sample (#6)

Posted by ja...@apache.org.

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

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

commit c14671a433335a666e4f4a2b177fbd48c065dab0
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Dec 5 16:21:19 2018 +0100

    Create a minimal reproduction repository or sample (#6)
    
    * initial description
    
    * link in README
    
    * Janpio Reproduction Grammar Correction (#8)
    
    * improving the words
    
    * remove blabla, add tldr, fix some things
    
    * clean up headlines
---
 README.md              |  5 +--
 create-reproduction.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 88 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9383b17..983105b 100644
--- a/README.md
+++ b/README.md
@@ -6,10 +6,11 @@ This repository contains documents describing everything a contributor of Apache
 
 ## Topics
 
-- [GitHub Project Boards](github-project-boards.md)
+- [Create a minimal reproduction repository](create-reproduction.md)
+- [Deprecation and Archiving of Repositories](deprecation.md)
 
 ### Process
 
-- [Deprecation and Archiving of Repositories](deprecation.md)
+- [GitHub Project Boards](github-project-boards.md)
 - [GitHub Labels](github-labels.md)
 - [GitHub Templates](github-templates.md)
diff --git a/create-reproduction.md b/create-reproduction.md
new file mode 100644
index 0000000..4bb1247
--- /dev/null
+++ b/create-reproduction.md
@@ -0,0 +1,85 @@
+# Create a Minimal Reproduction Repository or Sample
+
+When reporting an issue or bug for any of the Apache Cordova packages, it is helpful to create and include a link to a reproduction repository or sample. This helps maintainers when reproducing, evaluating, debugging and finally fixing the associated issue.
+
+## Why?
+
+The goal of the reproduction repository is to replicate the bug in a minimal project that contains only the necessary platforms, libraries, and plugins to reproduce the bug. 
+
+For a Cordova maintainer it can be a lot of work to reproduce your specific issue as there are many aspects to your  working environment and source code. By creating a reproduction repository, you can prodive _all_ useful information to the maintainer and make this process much easier and faster.
+
+Very often users creating a minimal project discover that their problem is not actually a bug, but something unrelated that only manifests in their main project for other reasons. They also learn much more about why a problem is occuring and can add this information to their GitHub issue.
+
+## How?
+
+The steps below show how to create a reproduction repository on GitHub. (Any public accessible Git remote service is acceptable: GitHub, BitBucket, GitLab, etc).
+
+### TLDR:
+
+- Create a new Cordova project,
+- implement a reproduction of your problem, 
+- put the project on Github,
+- and post the link to the repository in your issue.
+
+### Step 1: Create a new GitHub repository
+
+1. [Create a new repository](https://github.com/new) on GitHub
+1. Insert a `Repository name`
+1. Select `Public` to make the repository publicly accessible  
+    **IMPORTANT:** Do not check "Initialize this repository with a README"
+1. Click `Create repository`
+
+### Step 2: Upload the clean Cordova project
+
+1. Create a new Cordova project
+1. Initialize a Git repository in the newly created project folder
+1. Commit the unchanged Cordova project
+1. Add the GitHub repository as a remote to that project
+1. Push the commit got GitHub
+
+Execute the following commands in the terminal to achieve the steps above:
+
+```
+$ cordova create reproduction-sample
+$ cd reproduction-sample
+$ git init
+$ git add .
+$ git commit -m "Initialize new Cordova project"
+$ git remote add origin git@github.com:<USERNAME>/<REPO_NAME>.git
+$ git push -u origin master
+```
+
+### Step 3: Add necessary dependencies
+
+Add and commit each platform(s) (`cordova platform add ...`) and/or plugin(s) (`cordova plugin add ...`) needed to reproduce the problem.
+
+**Example:**
+```
+$ cordova platform add android
+$ git add .
+$ git commit -m "cordova platform add android"
+$ cordova plugin add cordova-plugin-inappbrowser
+$ git add .
+$ git commit -m "cordova plugin add cordova-plugin-inappbrowser"
+$ git push origin master
+```
+
+### Step 4: Reproduce the issue
+
+Update the project source code to reproduce and trigger the problem.
+
+### Step 5: Upload the finished reproduction code
+
+Commit and push the reproduction code.
+
+**Example:**
+```
+$ git commit -m "Reproduce problem"
+$ git push origin master
+```
+
+### Step 6: Create and submit the issue
+
+In the Apache Cordova GitHub issue, supply the link to the public repository.
+
+Later, the repository can be used to test if the problem has been resolved in a future update in regards to the library that was faulty.


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

[cordova-contribute] 04/11: .editorconfig for better code and markdown auto-formatting

Posted by ja...@apache.org.

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

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

commit ffbb522051e335b1abd48a74c062491b2ff5565f
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Thu Aug 23 14:56:00 2018 +0200

    .editorconfig for better code and markdown auto-formatting
---
 .editorconfig | 17 +++++++++++++++++
 README.md     |  3 ++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..251c64e
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,17 @@
+# EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/README.md b/README.md
index fbe1e3c..f56ff10 100644
--- a/README.md
+++ b/README.md
@@ -4,4 +4,5 @@ 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
+


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