1
0
mirror of https://github.com/namibia/free-programming-books.git synced 2024-11-22 03:25:09 +00:00

docs(contributing): archived resources guidelines (#6282)

* Update CONTRIBUTING

* Update CONTRIBUTING.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update CONTRIBUTING.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update CONTRIBUTING-it.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update CONTRIBUTING.md

* Update

* Update CONTRIBUTING.md

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>

* Sync translation

* Add RIP Tutorial

* Add RIP Tutorial

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>
Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
This commit is contained in:
ImVector 2021-10-26 17:22:38 +02:00 committed by GitHub
parent 92a8369fb5
commit 9266b59632
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 3 deletions

View File

@ -45,7 +45,8 @@ I collaboratori accettano di rispettare il [Codice di Comportamento](https://git
- preferisci gli atomic commits (un commit per aggiunta/modifica/eliminazione) rispetto ai grandi commit. Non c'è bisogno di raggruppare i commit per inviarli in una sola PR. (Non applichiamo mai questa regola, è solo per comodità dei moderatori) - preferisci gli atomic commits (un commit per aggiunta/modifica/eliminazione) rispetto ai grandi commit. Non c'è bisogno di raggruppare i commit per inviarli in una sola PR. (Non applichiamo mai questa regola, è solo per comodità dei moderatori)
- se il libro è più vecchio, includi la data di pubblicazione assieme al titolo. - se il libro è più vecchio, includi la data di pubblicazione assieme al titolo.
- includi il nome o i nomi degli autori se è il caso. Puoi accorciare il nome degli autori con "et al." - includi il nome o i nomi degli autori se è il caso. Puoi accorciare il nome degli autori con "et al."
- se il libro non è ancora finito, e ci stanno ancora lavorando su, aggiungi "in process", come descritto [qui sotto.](#in_process) - se il libro non è ancora finito, e ci stanno ancora lavorando su, aggiungi "in process", come descritto [qui sotto](#in_process). Seleziona sempre l'ultima versione disponibile in questi siti.
- se una risorsa è archiviata usando la Wayback Machine di Internet Archive (o simili), aggiungi la notazione "archived", come descritto [qui sotto](#archived). La versione migliore da utilizzare è quella più recente/completa.
- se è richiesto un indirizzo email o un account per poter scaricare il libro, aggiungilo tra parentesi, esempio: `(email address *requested*, not required)` - se è richiesto un indirizzo email o un account per poter scaricare il libro, aggiungilo tra parentesi, esempio: `(email address *requested*, not required)`
<a name="formatting"></a> <a name="formatting"></a>
@ -121,6 +122,13 @@ CORRETTO: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane R
CORRETTO: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*) CORRETTO: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
``` ```
<a name="archived"></a>
- Link archiviato:
```
CORRETTO: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
```
### Note ### Note
Mentre le basi sono relativamente semplici, c'è una notevole differenza tra le risorse che inseriamo nelle liste. Qui ci sono alcuni appunti su come affrontiamo queste diversità. Mentre le basi sono relativamente semplici, c'è una notevole differenza tra le risorse che inseriamo nelle liste. Qui ci sono alcuni appunti su come affrontiamo queste diversità.
@ -147,7 +155,7 @@ I nostri elenchi forniscono un set minimo di metadati: titoli, URLs, autori, pia
- Vogliamo dare i crediti agli autori ove appropriato, anche ai traduttori! - Vogliamo dare i crediti agli autori ove appropriato, anche ai traduttori!
- Per i lavori tradotti, l'autore originale dovrebbe essere incluso. - Per i lavori tradotti, l'autore originale dovrebbe essere incluso.
- Non permettiamo collegamenti per gli autori. - Non permettiamo collegamenti per gli autori.
- Per le compilation o remix, il "creatore" potrebbe aver bisogno di una descrizione. Ad esempio, i libri "GoalKicker" sono accreditati come "Compiled from StackOverflow documentation" - Per le compilation o remix, il "creatore" potrebbe aver bisogno di una descrizione. Ad esempio, i libri "GoalKicker" o "RIP Tutorial" sono accreditati come "Compiled from StackOverflow documentation"
##### Piattaforme e note di accesso ##### Piattaforme e note di accesso

View File

@ -45,6 +45,7 @@ By contributing you agree to respect the [Code of Conduct](https://github.com/Eb
- if the book is older, include the publication date with the title. - if the book is older, include the publication date with the title.
- include the author name or names where appropriate. You can shorten author lists with "et al." - include the author name or names where appropriate. You can shorten author lists with "et al."
- if the book is not finished, and is still being worked on, add the "in process" notation, as described [below.](#in_process) - if the book is not finished, and is still being worked on, add the "in process" notation, as described [below.](#in_process)
- if a resource is restored using the Internet Archive's Wayback Machine (or similar), add the "archived" notation, as described [below](#archived). The best versions to use are recent and complete.
- if an email address or account setup is requested before download is enabled, add language-appropriate notes in parentheses, e.g.: `(email address *requested*, not required)` - if an email address or account setup is requested before download is enabled, add language-appropriate notes in parentheses, e.g.: `(email address *requested*, not required)`
### Formatting ### Formatting
@ -119,6 +120,13 @@ GOOD: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe
GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*) GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
``` ```
<a name="archived"></a>
- Archived link:
```
GOOD: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
```
### Notes ### Notes
While the basics are relatively simple, there is a great diversity in the resources we list. Here are some notes on how we deal with this diversity. While the basics are relatively simple, there is a great diversity in the resources we list. Here are some notes on how we deal with this diversity.
@ -145,7 +153,7 @@ Our lists provide a minimal set of metadata: titles, URLs, creators, platforms,
- We want to credit the creators of free resources where appropriate, including translators! - We want to credit the creators of free resources where appropriate, including translators!
- For translated works the original author should be credited. - For translated works the original author should be credited.
- We do not permit links for Creators. - We do not permit links for Creators.
- For compilation or remixed works, the "creator" may need a description. For example, "GoalKicker" books are credited as "Compiled from StackOverflow documentation" - For compilation or remixed works, the "creator" may need a description. For example, "GoalKicker" or "RIP Tutorial" books are credited as "Compiled from StackOverflow documentation"
##### Platforms and Access Notes ##### Platforms and Access Notes