Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 5.58 KB

index.md

File metadata and controls

92 lines (60 loc) · 5.58 KB
Raw
layout
default

Intro

WILDS will and does have publicly available code in varying states of usability, development, and support. We think it's important to get code in users hands early and often to make sure we're solving users needs; given that situation, we want to clearly communicate that the software may not be stable yet. On the other extreme software may no longer be maintained, and we want to have a standard way to communicate about that as well.

Software maintainers often achieve this communication about the status of a piece of software using a simple badge at the top of the landing page for the software.

These badges are adapted from Repostatus.org.

Repo Statuses

  • Concept – Not useable, no support, not open to feedback, unstable API.
  • Experimental – Useable, some support, not open to feedback, unstable API.
  • Prototype – Useable, some support, open to feedback, unstable API.
  • Stable – Useable, full support, open to feedback, stable API.
  • Deprecated – Useable as of a fixed, past date, no support, not open to feedback, stable API as of a fixed, past date.

What It Looks Like

Project Status: Stable – Useable, full support, open to feedback, stable API.

This incorporates three components:

  1. The image URL, which serves as the machine-readable status identifier. It points to a status-specific image hosted on getwilds.org.
  2. Alt-text on the image (this can generally be viewed in a browser by mousing over the image) which begins with the canonical project status ("Project Status: ") and can optionally be followed by a human-readable description of the status, provided by the project's maintainer(s). Such text might also be useful to appear after the badge.
  3. The image is linked back to the particular status description at https://getwilds.org/badges/.

Use a badge

Click any of the below buttons to copy to your clipboard the text for badges for the 5 badge types and for each of 3 markup types (Markdown, Restructured text (ReST), or HTML; i.e., if your README is a markdown file, get the Markdown version of the badge).

Concept Project Status: Concept – Not useable, no support, not open to feedback, unstable API.

Markdown ReST HTML

Experimental Project Status: Experimental – Useable, some support, not open to feedback, unstable API.

Markdown ReST HTML

Prototype Project Status: Prototype – Useable, some support, open to feedback, unstable API.

Markdown ReST HTML

Stable Project Status: Stable – Useable, full support, open to feedback, stable API.

Markdown ReST HTML

Deprecated Project Status: Deprecated – Useable as of a fixed, past date, no support, not open to feedback, stable API as of a fixed, past date.

Markdown ReST HTML
Badge copied to clipboard!

References

These badges and content of this repository were adapted from the following sources: