You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A metadata description standard for public software and policy repositories that is easy to use both for developers and less technical people in order to make the software developed by public administrations and public organisations easily discoverable.
5
+
A metadata description standard for public software and policy repositories
6
+
that is easy to use both for developers and people with less technical
7
+
background, in order to make the software developed by Public Administrations
[See all versions](https://github.com/italia/publiccode.yml/releases)
12
13
13
14
This project follows the Semantic Versioning.
14
15
@@ -18,40 +19,46 @@ The PublicCode specification is developed by the [Italian Digital Transformation
18
19
19
20
## What this file is for
20
21
21
-
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 these 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.
22
-
23
-
The `publiccode.yml` file is meant to solve these 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 for computers. It contains information such as:
24
-
25
-
* The title and description of the project or product in English and/or other languages
26
-
* The status of development, e.g. `concept`, `development`, `beta`, `stable`, `obsolete`
27
-
* By what organisation this project is developed
28
-
* Who is caring for the maintenance and when this runs out
29
-
* Who to contact for technical or support inquiries
30
-
* What national and local legal frameworks this project or product works in
31
-
* What software dependencies this project or product has
32
-
33
-
The format should both be able to easily be added to any new project, as well as grow with the project as it grows beyond the original context it was developed in.
22
+
Many great software projects are developed by public administrations, however
23
+
reuse of these projects is very limited. Some of the reasons for low uptake of
24
+
such projects is a lack of discoverability and that it is hard to find out
25
+
what project can actually work in the context of a different public
26
+
administration.
27
+
28
+
The `publiccode.yml` file is meant to solve all those problems. As such, it is an easily
29
+
readable file for civil servants that are trying to figure out whether
30
+
a project will work for them, and easily readable for computers as well. It contains
31
+
information such as:
32
+
33
+
* the title and description of the project or product in English and/or other languages;
34
+
* the development status, e.g. `concept`, `development`, `beta`, `stable`, `obsolete`;
35
+
* which organisation developed the project;
36
+
* who is caring for the maintenance and when this expires;
37
+
* who to contact for technical or support inquiries;
38
+
* what national and local legal frameworks this project or product is designed
39
+
for;
40
+
* what software dependencies this project or product has.
41
+
42
+
The `publiccode.yml` file format should both be able to easily be added to any
43
+
new project, as well as grow with the project as it expands beyond the original
44
+
context it was developed in.
34
45
35
46
## Finding projects
36
47
37
-
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.
48
+
Finding projects depends on how the search API is structured for every hosting
49
+
platform. For example, you can find all `publiccode.yml` on GitHub files by
The Italian Digital Transformation Team is also working on providing a scanner which looks for all PublicCode files on all publicly accessible websites, and exposing them as open data.
42
-
43
-
## Live editor / Demo
44
-
45
-
You can find a live instance of the editor [here](http://publiccode.surge.sh/)
54
+
The Italian Digital Transformation Team is also working on providing a scanner
55
+
which looks for all publiccode files on all publicly accessible websites, and
56
+
exposing them as open data.
46
57
47
58
## Contributing
48
59
49
60
Feel free to submit [Pull Requests and to file Issues](CONTRIBUTING.md).
50
61
51
-
## Website
52
-
53
-
The website at <https://w3id.org/publiccode/> is automatically generated from the `master` branch of the [`publiccode.yml` repository](https://github.com/italia/publiccode.yml) using [GitHub pages](https://pages.github.com) and its static site generator [Jekyll](https://jekyllrb.com).
0 commit comments