Code-dot-mil/code.mil

Add documentation on how to do good OSS documentation

开放

#240 创建于 2018年9月6日

 (17 条评论) (0 个反应) (0 位负责人)JavaScript (115 个派生)batch import
[effort] small[issue-type] content[skill-level] beginnercode.govhelp wanted

仓库指标

星标
 (1,238 个星标)
PR 合并指标
 (30 天内没有已合并 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.

贡献者指南