|
|
||
|---|---|---|
| assets/images/badges | ||
| docs | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
Project Status Badges
Badges for quickly and easily indicating the status of a project.
Project Status Badges are a collection of unique status badges that you can use to indicate the development status of your project. For example, you can put them in your project's README.md file.
The badges were derived from Shields.io Badges, a CC0 project which provides badges as a service. This means that the project status badges will be visually compatible with the Shields.io Badges - so you can use both in your project.
Features
- Project Status Badge: 'Maintained'
- Project Status Badge: 'Finished'
- Project Status Badge: 'Unfinished'
- Project Status Badge: 'Abandoned'
Usage
Copying The Badge (Recommended)
- Copy-paste the badge(s) you want to use into your project. To keep things organised you can put the badge(s) in a folder such as
assets/images/badges.
Note
If you put your badge into a different folder or named the file differently, you will need to adjust the file paths so that they lead to the correct location.
Markdown
-
Add the following text to your file:
[](https://gitlab.com/esoterictemplates/assets/images/symbols/project-status-badges/-/tree/DOCUMENTATION_VERSION#CURRENT_PROJECT_STATUS)Alternatively, you can use link aliases to keep things short and organised.
[![Project status: CURRENT_PROJECT_STATUS][status]][project-status] [status]: ./assets/images/badges/CURRENT_PROJECT_STATUS.svg [project-status]: https://gitlab.com/esoterictemplates/assets/images/symbols/project-status-badges/-/tree/DOCUMENTATION_VERSION#CURRENT_PROJECT_STATUSReplace:
CURRENT_PROJECT_STATUSwith the lowercase project status you want to use; andDOCUMENTATION_VERSIONwith the documentation version you want to use.
Linking To This Repository
Warning
If this repository ever goes offline, links to the badges will stop working! In that case, images will no longer load if you link to this repository.
Markdown
-
Add the following text to your file:
[](https://gitlab.com/esoterictemplates/assets/images/symbols/project-status-badges/-/tree/DOCUMENTATION_VERSION#CURRENT_PROJECT_STATUS)Alternatively, you can use link aliases to keep things short and organised.
[![Project status: CURRENT_PROJECT_STATUS][status]][project-status] [status]: https://gitlab.com/esoterictemplates/assets/images/symbols/project-status-badges/-/raw/VERSION/assets/images/badges/CURRENT_PROJECT_STATUS.svg [project-status]: https://gitlab.com/esoterictemplates/assets/images/symbols/project-status-badges/-/tree/DOCUMENTATION_VERSION#CURRENT_PROJECT_STATUSReplace:
CURRENT_PROJECT_STATUSwith the lowercase project status you want to use;VERSIONwith the version of the badge you want to use; andDOCUMENTATION_VERSIONwith the documentation version you want to use.
Versions
This repository uses the format badge-version for its tags, where:
badgeis the lowercase project status (e.g.,maintained,abandoned); andversionis the Semantic Versioning string which describes the version of thebadge.
This repository also uses regular Semantic Versioning strings for the documentation (the explanations of the project status).
You can also use the name of a branch in links to get the most recent badges and documentation on that branch. Use the main branch to be fully up-to-date.
Links
- GitLab
- GitHub
- Gitea
- GitGud
- GitFlic
- git.gay
- Bitbucket
- Buddy
- Codeberg
- Disroot
- Moe's Git
- FramaGit
- SourceForge
- tangled
- 〄.ai
- Launchpad
- Azure DevOps
- pub.solar
- repo.or.cz
- HelixTeamHub
- Credit
Project Status
This system defines 4 distinct states at which a project can be:
These statuses can be organised and described by the following table:
| v Stable version? \ WIP? > | Yes | No |
|---|---|---|
| Yes |  |
 |
| No | |
 |
Stable Versions
A stable version of a project is defined as a version or revision of the project that you would consider complete - it should:
- contain all of the features that were originally planned for the project (if any); and
- not contain any known bugs or issues (ideally, it shouldn't contain any bugs or issues).
Work in Progress Projects
A project is work in progress if:
- it may still be updated in the future; or
- it is actively being developed right now.
Maintained
Maintained projects are mature, have at least one stable version and are still being developed, or they are simply being kept up-to-date. This is the 'ideal' state for a project.
Finished
Finished projects are self-explanatory: the project has been marked as complete and won't be worked on anymore. This is the best-case scenario for projects you don't want to work on anymore.
Unfinished
Unfinished projects are still in a work-in-progress state and may not have all of their intended features implemented. There may be bugs or issues.
Abandoned
Abandoned projects are those which do not have a stable (complete) version and which the author(s) decided are not worth working on anymore.
Verification
The badges and icon of this project have been verified using the W3C Markup Validation Service and the W3C RDF Validation Service. See the output for yourself here:
Markup Validation
RDF Validation
License
ISC License
Copyright 2025 Esoteric Enderman
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.