A standard to easily communicate to humans and machines the development/support and usability status of software repositories/projects.
For the majority of documentation and human-readable text, see https://www.repostatus.org/ or the gh-pages branch from which it is built.
Please feel free to leave comments as Issues, or open pull requests.
This project seems to have gained a lot more interest than I thought it would. As of April, 2017 there are over 1,200 references on GitHub to repostatus.org badge URLs. I do not want to be the sole person making decisions for this project. I encourage everyone who finds it useful to watch the repo on GitHub and provide their feedback in discussions, especially the issues with the discussion or "needs decision" labels. I'm handling the code updates, but I very much want this project to be driven based on consensus of those who use it.
For changes to the site, text, or anything other than the badges themselves (and their descriptions and sample markup),
simply cut a pull request against the master branch. The content that appears on the website (in the gh-pages branch)
comes from gh_pages/
in master. Note that some of it (described below) is generated programmatically.
The badges (SVG), their descriptions and their sample markup are generated by a Fabfile. If you're looking
to add a new badge or make changes to an existing one, update the badge_info
dictionary at the top of fabfile.py
and
then run fab make-badges
(requires Python and some packages; see the comment at the top of the file for requirements). This will
regenerate all badges, metadata and samples into badges/latest
. You can then cut a pull request for this; a version number will
be assigned at merge time. Please remember to also update gh_pages/index.md
for any badge changes.
fab make-badges
and ensure there are no new changes.fab version-badges x.y.z
(where x.y.z
is the version number).CHANGELOG.md
entry.fab badges2pages
to copy the badges under gh-pages/
fab publish
to push changes to the gh-pages branch.