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 2018/12/04 14:10:14 UTC
[cordova-contribute] branch master updated: Deprecation and
Archiving (#2)
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git
The following commit(s) were added to refs/heads/master by this push:
new d1681b5 Deprecation and Archiving (#2)
d1681b5 is described below
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