unisonweb/unison

Revamp README

Open

#832 创建于 2019年10月1日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Haskell (304 fork)batch import
documentationhelp wanted

仓库指标

Star
 (6,624 star)
PR 合并指标
 (平均合并 10天 2小时) (30 天内合并 5 个 PR)

描述

README is kinda out of date and could use a refresh. Let’s use this ticket to discuss ideas for what should go in it. Would someone like to take a crack at proposing an outline?

One thing to keep in mind is that we have both the website and the README, so let’s not duplicate content that’s already on the website. README can certainly point to the website.

Prompted by #831

贡献者指南

研究方向
阅读此议题上的三条现有评论以了解讨论要点。查看仓库中当前的 README 文件（可能在根目录）。理解 README 与项目网站之间的职责分离。为新的 README 提出一个结构化大纲，注意讨论内容并避免与网站内容重复。
技术栈
无
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Familiarity with UnisonDocumentation writing skills
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60