Skip to content

Commit 5a9244a

Browse files
committed
feat: added info in README
1 parent 54c5591 commit 5a9244a

1 file changed

Lines changed: 31 additions & 17 deletions

File tree

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,50 @@
11
# The `publiccode.yml` standard
22

3-
![Repo Status: Alpha](https://img.shields.io/badge/status-alpha-lightgrey.svg?longCache=true&style=plastic)
3+
![Repo Status:
4+
Alpha](https://img.shields.io/badge/status-alpha-lightgrey.svg?longCache=true&style=plastic)
45

56
A metadata description standard for public software and policy repositories
67
that is easy to use both for developers and people with less technical
78
background, in order to make the software developed by Public Administrations
89
and Public Organisations easily discoverable.
910

10-
**Latest release: [Version 0.1](https://github.com/italia/publiccode.yml/releases/latest)**
11+
**Latest release: [Version
12+
0.1](https://github.com/italia/publiccode.yml/releases/latest)**
1113

1214
[See all versions](https://github.com/italia/publiccode.yml/releases)
1315

14-
This project follows the Semantic Versioning.
16+
This project follows the Semantic Versioning. For more information see
17+
[SemVer.org](https://semver.org/).
1518

16-
For more information see [SemVer.org](https://semver.org/).
19+
Furthermore, the project uses branches and tags in the following way:
20+
* The `master` branch contains the latest stable version of the standard.
21+
* The `development` branch contains the improvements proposed for the next
22+
version.
23+
* GitHub's [release page](https://github.com/italia/publiccode.yml/releases)
24+
contains all the released versions of the standard. Releases are done
25+
following the tag version for consistency (e.g., tag v0.1 implies release
26+
v0.1).
1727

18-
The PublicCode specification is developed by the [Italian Digital Transformation Team](https://teamdigitale.governo.it) and the [Authors](AUTHORS.md).
28+
The PublicCode specification is developed by the [Italian Digital
29+
Transformation Team](https://teamdigitale.governo.it) and the
30+
[Authors](AUTHORS.md).
1931

2032
## What this file is for
2133

2234
Many great software projects are developed by public administrations, however
2335
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`;
36+
such projects is a lack of discoverability and that it is hard to find out what
37+
project can actually work in the context of a different public administration.
38+
39+
The `publiccode.yml` file is meant to solve all those problems. As such, it is
40+
an easily readable file for civil servants that are trying to figure out
41+
whether a project will work for them, and easily readable for computers as
42+
well. It contains information such as:
43+
44+
* the title and description of the project or product in English and/or other
45+
languages;
46+
* the development status, e.g. `concept`, `development`, `beta`, `stable`,
47+
`obsolete`;
3548
* which organisation developed the project;
3649
* who is caring for the maintenance and when this expires;
3750
* who to contact for technical or support inquiries;
@@ -49,7 +62,8 @@ Finding projects depends on how the search API is structured for every hosting
4962
platform. For example, you can find all `publiccode.yml` on GitHub files by
5063
searching using the frontend or the API.
5164

52-
* [GitHub Search `filename:publiccode.yml path:/`](https://github.com/search?q=filename%3Apubliccode.yml+path%3A%2F)
65+
* [GitHub Search `filename:publiccode.yml
66+
path:/`](https://github.com/search?q=filename%3Apubliccode.yml+path%3A%2F)
5367

5468
The Italian Digital Transformation Team is also working on providing a scanner
5569
which looks for all publiccode files on all publicly accessible websites, and

0 commit comments

Comments
 (0)