deprecation_policy.md 2.5 KB
layout: contribute
title: Apache Cordova Deprecation and Archiving Policy
Deprecation and Archiving Policy
Apache Cordova has been around quite some time, having been started back in August 2008. As it consists of many individual "parts", some of those stopped being useful for any number of reasons. This "Deprecation and Archiving Policy" describes why, when and how projects can be deprecated and archived - and what that actually means.
Deprecation Policy
When a piece of Apache Cordova stops being useful or necessary we vote on deprecating it on our dev mailing list.
Reasons for Deprecation
Some common reasons for deprecation of a component of Apache Cordova are:
- General availability of a web standard that achieves the same thing
- A better replacement is available somewhere else
- Usage of a platform declined to a non relevant level
- A platform was deprecated itself by its producer
Meaning of Deprecation
When we deprecate a component it means no more work will be done on it. We make the deprecation clearly visible in the project's README.md (via a "Deprecation Notice") and repository description.
Users can still use the component as before, we just put them on notice that the software might go away or break in the future - e.g. with new operating system releases or bugs might be found - and we won't fix this any more.
Users can also still fork the repository and create their own bug fixes and even new features. The forks will be discoverable with the GitHub "Network" and "Forks" features. There you can see all forks available and easily spot extra commits people have done in an easy and visual way.
Archiving Policy
A deprecated repository might also be archived if we don't intend to provide support of any kind (Issues, Pull Requests, Releases) for this component any more. This decision is also made on our dev mailing list.
A repository can be deprecated and archived at the same time.
Meaning of Archiving
As well as the points listed in Meaning of Deprecation, an archived repository is "read only". This is achieved by using GitHub's archive repositories feature:
When a repository is archived, its issues, pull requests, code, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions, and comments become read-only. To make changes in an archived repository, you must unarchive the repository first.