Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/publiccodeyml/publiccode.yml
A metadata standard for public software
https://github.com/publiccodeyml/publiccode.yml
discoverability floss government government-procurement metadata-standard publiccode yml
Last synced: about 1 month ago
JSON representation
A metadata standard for public software
- Host: GitHub
- URL: https://github.com/publiccodeyml/publiccode.yml
- Owner: publiccodeyml
- License: cc0-1.0
- Created: 2018-07-04T13:58:43.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T09:31:51.000Z (5 months ago)
- Last Synced: 2024-02-21T06:38:06.551Z (5 months ago)
- Topics: discoverability, floss, government, government-procurement, metadata-standard, publiccode, yml
- Language: Python
- Homepage: https://yml.publiccode.tools
- Size: 2.71 MB
- Stars: 115
- Watchers: 18
- Forks: 37
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Governance: governance/charter.md
- Authors: AUTHORS.md
Lists
- awesome-egov-de - GitHub
- .github - publiccode.yml
- awesome-stars - publiccodeyml/publiccode.yml - A metadata standard for public software (Python)
- awesome-open-source - publiccode.yml - Standard to express meta data for a repository, used in code for public administration (Using / Project quality)
README
The publiccode.yml Standard
A metadata description standard for public software that is easy to use both for
developers and people with less technical background in order to make the
software developed by Public Administrations and Public Organisations easily discoverable.
## What `publiccode.yml` is for
Many great software projects are developed by public administrations, however
reuse of these projects is very limited. Some of the reasons for low uptake of
such projects is a lack of discoverability and that it is hard to find out what
project can actually work in the context of a different public administration.
The `publiccode.yml` file is meant to solve all those problems. It is
an easily readable file for civil servants that are trying to figure out
whether a project will work for them, and easily readable by computers as
well. It contains information such as:
* the title and description of the project in English and/or other
languages;
* the development status, e.g. `concept`, `development`, `beta`, `stable`,
`obsolete`;
* which organisation developed the project;
* who is caring for the maintenance and when this expires;
* who to contact for technical or support inquiries;
* what national and local legal frameworks the project is designed
for;
* what software dependencies the project has.
The `publiccode.yml` file format should both be able to easily be added to any
new project, as well as grow with the project as it expands beyond the original
context it was developed in.
## Finding projects
Finding projects depends on how the search API is structured for every hosting
platform. For example, you can find all `publiccode.yml` on GitHub files by
searching using the frontend or the API.
* [GitHub Search `path:publiccode.yml`](https://github.com/search?q=path%3Apubliccode.yml&type=code)
## Versioning
**Latest release:** [](https://github.com/publiccodeyml/publiccode.yml/releases) [See all versions](https://github.com/publiccodeyml/publiccode.yml/releases)
This project follows the Semantic Versioning. For more information see
[SemVer.org](https://semver.org/).
Furthermore, the project uses branches and tags in the following way:
* The `main` branch contains the improvements coming up in the next version.
* [Release page](https://github.com/publiccodeyml/publiccode.yml/releases)
contains all the released versions of the standard. Releases are tagged
with the Standard's version.
## Contributing
Feel free to submit [Pull Requests and to file Issues](CONTRIBUTING.md).
## Licence
Licenced under the [CC0-1.0](LICENSE).