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/08/22 21:53:45 UTC

[cordova-contribute] 05/06: polish

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

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

commit 14fdd66ea401760ffb29012b5fc2610f0eca157c
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 20:21:35 2018 +0200

    polish
---
 README.md      |  2 +-
 deprecation.md | 26 +++++++++++++++-----------
 2 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 6b25209..135b9ce 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,4 @@ This repository contains documents describing everything a contributor of Apache
 
 ### Process
 
-- [Deprecation Policy](deprecation.md)
\ No newline at end of file
+- [Deprecation and Archiving of Repositories](deprecation.md)
\ No newline at end of file
diff --git a/deprecation.md b/deprecation.md
index 8a5c9d3..c09e9d0 100644
--- a/deprecation.md
+++ b/deprecation.md
@@ -1,28 +1,32 @@
+# 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. Make changes in README
+### 1. Make changes in `README.md`
 
-Add the [Deprecation Notice Template](#deprecation-notice-templates) to the `README.md` of the project. Add a reason and a link to further information (blog post, web standard definition etc.).
+Add the [Deprecation Notice Template](#deprecation-notice-templates) to the `README.md` of the project. Add a reason and a link to further information (e.g. blog post, web standard definition etc.).
 
-### 2. Request GitHub repository archiving
+### 2. Request GitHub repository changes
 
-To request archiving of a repository, a [PMC](TODO) member has to [open an issue with Apache INFRA](https://issues.apache.org/jira/browse/INFRA).
+A [PMC](TODO) member has to [open an issue with Apache INFRA](https://issues.apache.org/jira/browse/INFRA) to request changes to the GitHub repository.
 
 For deprecation:
 
-1. Make sure deprecation notice is in README and contains all information
-1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that the repository description is prefixed with [DEPRECTATED]
+1. Make sure 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 `[DEPRECTATED]`
 
 For archiving:
 
-1. Make sure there are no more open issues and Pull Requests for this repository. If there are, please close them with this suggested text or similar:
+1. Make sure there are no more open Issues and Pull Requests for this repository  
+If there are, please close them with this suggested text or similar:
    > TODO  
    > We are archiving this repository following our deprecation policy documented at ..TODO..  
    > Thanks for your issue or pull request anyway.  
    > TODO
-1. Make sure deprecation notice is in README and contains all information
-1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request a) that the repository description is prefixed with [DEPRECTATED] and b) the repository is archived.
+1. Make sure deprecation notice is in `README.md` and contains all information
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request a) that the repository description is prefixed with `[DEPRECTATED]` and b) the repository is archived on GitHub
 
 ## Deprecation Notice Templates
 
@@ -31,7 +35,7 @@ For archiving:
 
 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 in the future but any more future issues will not be fixed by the Cordova community.
 
-Feel free to fork this repository and work on your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
 
 - Reason for deprecation: ...
 - Learn more: https://example.org/article
@@ -45,7 +49,7 @@ Feel free to fork this repository and work on your fork. Existing forks are list
 
 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 in the future but any more future issues will not be fixed by the Cordova community.
 
-Feel free to fork this repository and work on your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
 
 - Reason for deprecation: ...
 - Learn more: https://example.org/article


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