Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecation and Archiving #2

Merged
merged 13 commits into from
Dec 4, 2018
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
57 changes: 57 additions & 0 deletions deprecation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# 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.md`
janpio marked this conversation as resolved.
Show resolved Hide resolved

Add the [Deprecation Notice Template](#deprecation-notice-template) 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 changes

A PMC 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.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 there are no more open Issues and Pull Requests for this repository
If there are, please close them with this suggested text or similar:
> 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
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.
```
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 a) the repository description is prefixed with `[DEPRECATED]` and b) the repository is archived on GitHub

## Deprecation Notice Template

---
**Deprecation Notice**
janpio marked this conversation as resolved.
Show resolved Hide resolved

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).

- Reason for deprecation: ...
- Learn more: https://example.org/article
---

### 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).

- Reason for deprecation: ...
- Learn more: https://example.org/article
---
```