Code-dot-mil/code.mil

Add documentation on how to do good OSS documentation

Ouverte

#240 ouverte le 6 sept. 2018

Voir sur GitHubGuide contributeur
 (17 commentaires) (0 réaction) (0 personne assignée)JavaScript (115 forks)batch import
[effort] small[issue-type] content[skill-level] beginnercode.govhelp wanted

Métriques du dépôt

Stars
 (1 238 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Feature

We would like to have better documentation on how to create good open source software documentation as guidance for Department organizations wishing to open source things. This should include things like relevant sections of a "contributing" doc (not just a link to an example), how to write and review PRs, good commit messages, how to write a good GH issue, etc.

Page(s) Affected

This could go on https://www.code.mil/how-to-open-source.html ("How to Open Source"), but it could live on it's own page, linked a couple of places.

Guide contributeur

Direction de recherche
Examinez la documentation existante sur code.mil, en particulier la page 'How to Open Source'. Recherchez les meilleures pratiques pour les documents de contribution OSS, les directives de révision des PR, les messages de commit et la rédaction des issues. Proposez une structure pour la nouvelle page de documentation.
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70