Make the Repository collaboration-ready

[nicolaerario]

Butto giù una bozza di checklist per rendere il repository pronto alla collaborazione.
Collaboriamo per rendere la lista definitiva 😎

1. Repository Settings

• set appropriate repository visibility (public or private)
• configure branch protection rules

2. Repository Contents

• create an informative README.md
• add a LICENSE.md file
• include CONTRIBUTING.md
• set up CODEOWNERS
• establish a CODE_OF_CONDUCT.md

3. Automation/Checks

• implement code linting / formatting
• set up tests / Continuous Integration (CI)
• configure status checks
• set up Continuous Deployment (CD)

4. Security

• assign appropriate roles / permissions
• manage secrets securely
• set up scanners for dependencies, secrets, general vulnerabilities
• setup Dependabot version updates
• provide a SECURITY.md

5. Advanced Options

• add Issue Templates
• define Environments

6. Next Steps / Externalities

• commit to being responsive
• use GitHub Projects and Issues for project management
• promote the project for visibility
• engage with the community

[nicolaerario]

Ho voluto rendela più generale possibile di proposito, naturalmente alcuni punti (come il 3 ad esempio) dipendono da decisioni future.

[nicolaerario]

Perfetto grazie. Intanto io ho messo, c’è sempre tempo per togliere. E poi, vuoi mettere la soddisfazione di automatizzare le build dei capitoli, indice ecc? 😎

[Cadienvan]

Sky is the limit!

[francescobianco]

@nicolaerario @Cadienvan al contrario sono convito che invece una CI sia proprio necessaria per un libro, soprattutto se nasce in questo contesto. C'è bisogno di dare l'esempio e mostrare come anche un libro sia un artefatto che può essere processato da processi automatici per la qualità. Ecco alcuni esempi da considerare per la CI/CD.

• Controllo automatico lessicale e grammaticale
• Generazione automatica di indici e bibliografie
• Generazione e distribuzione degli artefatti finali, es. versione in PDF, ePUB, etc...

[Cadienvan]

Mi piace questa verve! Ahah va bebe, se po' fa'!

[nicolaerario]

@francescobianco sfondi una porta aperta con me

[nicolaerario]

Evoluto in issue #56