Code-dot-mil/code.mil

Add documentation on how to do good OSS documentation

オープン

#240 opened on 2018/09/06

 (17 件のコメント) (0 件のリアクション) (0 人の担当者)JavaScript (115 件のフォーク)batch import
[effort] small[issue-type] content[skill-level] beginnercode.govhelp wanted

Repository metrics

Stars
 (1,238 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

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.

コントリビューターガイド