Code-dot-mil / Code-dot-mil/code.mil

Add documentation on how to do good OSS documentation

未关闭
#240 17 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
[effort] small [issue-type] content [skill-level] beginner code.gov help wanted
主要语言
JavaScript
星标
1.3k
派生
144
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.

贡献指南

打开贡献指南

调研方向

首先阅读现有的 https://www.code.mil/how-to-open-source.html 页面,并审查此 Issue 中请求的指导领域:贡献文档、pull requests、commit 消息和 GitHub issues。指导内容完成撰写,放置在该页面或一个已链接的新页面上,并从相关位置链接到它,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
github
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。