Skip to content

Latest commit

 

History

History
executable file
·
47 lines (26 loc) · 2.69 KB

BADGES_GUIDE.md

File metadata and controls

executable file
·
47 lines (26 loc) · 2.69 KB
Raw

Badges Guide

This section presents a some badges reference guide from the readme file, which are project activity info and are not widely distributed or are attached special for this project.

Status

Status is an informational badge which shows the project development activity. This information can be represented by the following statuses:

  • active - this means that the project is under active development.
  • frozen - this means that the project is still under development, but all work on it was temporarily suspended to clarify and formalize new ideas.
  • completed - this means that the project implements the intended functionality and the development is completed. Development can be resumed if new ideas for an improvements or features appear.

If you want to help in development, you have any feature suggestions for the project or if you faced a problem or bug, please visit the contributing section.

Version

This information represents the actual version of the project. For the versioning is used SemVer.

Stable

Stable is an informational badge which shows the api interface stability. This information can be represented by the following:

  • yes - this means that the project in a stable state.
  • no - this means that the project is not in a stable state and some interfaces could be changed.

OSS Lifecycle

OSS Lifecycle is an initiative started by Netflix to classify open-source projects into lifecycles and clearly identify which projects are active and which ones are retired. To enable this badge, simply create an OSSMETADATA tagging file at the root of your GitHub repository containing a single line similar to the following: osslifecycle=active. Other suggested values are osslifecycle=maintenance and osslifecycle=archived. A working example can be viewed on the OSS Tracker repository.

Maintenance

This is an informational badge which shows the maintenance process state of the project. The following statuses are applied:

  • yes - this means that the project is under maintenance.
  • no (of {expiration date}) - this means that the project is no longer maintained.

In both cases, the project can still be used.

Please visit the contributing page if you faced with some issues with the project.

Release Date

This is an information about the project release date which would be stable and could be used. In this case, it is possible to indicate the date of the first release, last release, release of a specific version.

Commit Date

This is an information about the project commit date, which would show the last commit date in the project repository.