Skip to content

Commit 2004305

Browse files
authored
Update rules on contacts, better URLs explanation (#33)
* fix: updated rules on contacts * fix: better path description #32
1 parent 7b864c7 commit 2004305

File tree

3 files changed

+39
-19
lines changed

3 files changed

+39
-19
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# The `publiccode.yml` standard
22

3-
![Repo Status:
4-
Alpha](https://img.shields.io/badge/status-alpha-lightgrey.svg?longCache=true&style=plastic)
53
[![Join the #publiccode channel](https://img.shields.io/badge/Slack%20channel-%23publiccode-blue.svg)](https://developersitalia.slack.com/messages/CAM3F785T)
64
[![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)
75

@@ -83,4 +81,4 @@ considered the default landing page for the project.
8381

8482
## Licence
8583

86-
Licenced under the [CC-0](LICENSE)
84+
Licenced under the [CC-0](LICENSE).

docs/en/schema.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,10 @@ Key ``logo``
160160
This key contains the path to the logo of the software. Logos should be
161161
in vector format; raster formats are only allowed as a fallback. In this
162162
case, they should be transparent PNGs, minimum 1000px of width.
163+
The key value can be the relative path to the file starting from the root of
164+
the repository, or it can be an absolute URL pointing to the logo in raw
165+
version. In both cases, the file must reside inside the same repository where
166+
the publiccode.yml file is stored.
163167

164168
Key ``monochromeLogo``
165169
~~~~~~~~~~~~~~~~~~~~~~
@@ -172,6 +176,10 @@ Key ``monochromeLogo``
172176
A monochromatic (black) logo. The logo should be in vector format;
173177
raster formats are only allowed as a fallback. In this case, they should
174178
be transparent PNGs, minimum 1000px of width.
179+
The key value can be the relative path to the file starting from the root of
180+
the repository, or it can be an absolute URL pointing to the logo in raw
181+
version. In both cases, the file must reside inside the same repository where
182+
the publiccode.yml file is stored.
175183

176184
Key ``inputTypes``
177185
~~~~~~~~~~~~~~~~~~
@@ -536,6 +544,10 @@ Key ``description/[lang]/screenshots``
536544
This key contains one or multiple paths to files showing screenshots of
537545
the software. They are meant to give a quick idea on how the software
538546
looks like and how it works.
547+
The key value can be the relative path to the file starting from the root of
548+
the repository, or it can be an absolute URL pointing to the screenshot in raw
549+
version. In both cases, the file must reside inside the same repository where
550+
the publiccode.yml file is stored.
539551

540552
Screenshots can be of any shape and size; the suggested formats are:
541553

@@ -655,7 +667,7 @@ Key ``maintenance/contractors``
655667
'''''''''''''''''''''''''''''''
656668

657669
- Type: array of Contractor (see below)
658-
- Presence: mandatory (if ``maintainance/type`` is ``contract``)
670+
- Presence: mandatory (if ``maintainance/type`` **is** ``contract``)
659671

660672
This key describes the entity or entities, if any, that are currently
661673
contracted for maintaining the software. They can be companies,
@@ -665,7 +677,7 @@ Key ``maintenance/contacts``
665677
''''''''''''''''''''''''''''
666678

667679
- Type: List of Contacts (see below)
668-
- Presence: mandatory (if ``maintainance/type`` **is not** ``contract``)
680+
- Presence: mandatory (if ``maintainance/type`` **is** ``internal`` or ``community``)
669681

670682
One or more contacts maintaining this software.
671683

docs/it/schema.rst

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,12 @@ Chiave ``logo``
135135
- Formati accettabili: SVG, SVGZ, PNG
136136
- Esempio: ``img/logo.svg``
137137

138-
Questa chiave contiene il logo del software. I loghi dovrebbero essere
139-
tutti in formato vettoriale; i formati raster sono solo accettabili come
140-
fallback. In questo caso, dovrebbero essere PNG trasparenti, con una
138+
Questa chiave indica il logo del software. Il valore può essere il percorso
139+
relativo al file a partire dalla root del repository, oppure una URL assoluta
140+
che punta al logo in versione raw. In entrambi i casi, il file deve risiedere
141+
all'interno del medesimo repository che contiene il publiccode.yml. Il logo
142+
dovrebbe essere in formato vettoriale; i formati raster sono solo accettabili
143+
come fallback. In questo caso, dovrebbero essere PNG trasparenti, con una
141144
larghezza minima di 1000px.
142145

143146
Chiave ``monochromeLogo``
@@ -148,10 +151,14 @@ Chiave ``monochromeLogo``
148151
- Formati accettabili: SVG, SVGZ, PNG
149152
- Esempio: ``img/logo-mono.svg``
150153

151-
Un logo monocromatico (nero). Il logo dovrebbe essere in formato
152-
vettoriale; i formati raster sono solo accettabili come fallback. In
153-
questo caso, dovrebbero essere PNG trasparenti, con una larghezza minima
154-
di 1000px.
154+
Questa chiave indica il logo monocromatico (nero) del software. Il valore può
155+
essere il percorso
156+
relativo al file a partire dalla root del repository, oppure una URL assoluta
157+
che punta al logo in versione raw. In entrambi i casi, il file deve risiedere
158+
all'interno del medesimo repository che contiene il publiccode.yml. Il logo
159+
dovrebbe essere in formato vettoriale; i formati raster sono solo accettabili
160+
come fallback. In questo caso, dovrebbero essere PNG trasparenti, con una
161+
larghezza minima di 1000px.
155162

156163
Chiave ``inputTypes``
157164
~~~~~~~~~~~~~~~~~~~~~
@@ -535,9 +542,12 @@ Chiave ``description/[lang]/screenshots``
535542
- Formati: PNG, JPG
536543
- Esempio: ``"data/screenshots/configuration.png"``
537544

538-
Questa chiave contienete uno o più percorsi a file che mostrano immagini
539-
del software (screenshot). Queste ultime hanno lo scopo di dare un’idea
540-
veloce dell’aspetto del software e del suo funzionamento.
545+
Questa chiave indica una o più immagini del software (screenshot). Queste
546+
hanno lo scopo di dare una panoramica dell'aspetto del software e del
547+
suo funzionamento. Il valore può essere il percorso relativo al file a partire
548+
dalla root del repository, oppure una URL assoluta che punta all'immagine in
549+
versione raw. In entrambi i casi, il file deve risiedere all'interno del
550+
medesimo repository che contiene il publiccode.yml.
541551

542552
Queste immagini possono essere di qualsiasi formato e dimensione; i
543553
formati suggeriti sono:
@@ -629,10 +639,10 @@ Chiave ``legal/authorsFile``
629639
- Esempio: ``"doc/AUTHORS.txt"``
630640

631641
Qualche software open-source adotta una convenzione che identifica il
632-
proprietario del copyright attraverso un file elencante tutte le entità
642+
detentore del copyright attraverso un file elencante tutte le entità
633643
che possiedono il copyright. Questo è comune nei progetti fortemente
634644
sostenuti dalla community ove esistono diversi contributori esterni e
635-
non c’è un chiaro singolo possessore del copyright. In questi casi,
645+
non c’è un chiaro singolo detentore del copyright. In questi casi,
636646
questa chiave può essere usata per riferirsi al suddetto file degli
637647
autori, usando un percorso relativo alla radice (root) del repository.
638648

@@ -664,7 +674,7 @@ Chiave ``maintenance/contractors``
664674
''''''''''''''''''''''''''''''''''
665675

666676
- Tipo: array di Contractor (vedi sotto)
667-
- Presenza: obbligatoria (se ``maintainance/type`` è ``contract``)
677+
- Presenza: obbligatoria (se ``maintainance/type`` **è** ``contract``)
668678

669679
Questa chiave descrive l’entità o le entità, se ce ne sono, che
670680
attualmente hanno un contratto di manutenzione del software. Queste
@@ -674,7 +684,7 @@ Chiave ``maintenance/contacts``
674684
'''''''''''''''''''''''''''''''
675685

676686
- Tipo: Lista di Contatti (vedi sotto)
677-
- Presenza: obbligatoria (se e solo se ``maintainance/type`` **non è** ``contract``)
687+
- Presenza: obbligatoria (se ``maintainance/type`` **è** ``internal`` oppure ``community``)
678688

679689
Uno o più contatti di chi sta mantenendo il software.
680690

0 commit comments

Comments
 (0)