unisonweb/unison

Revamp README

Open

#832 建立於 2019年10月1日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Haskell (6,624 star) (304 fork)batch import
documentationhelp wanted

描述

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

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Familiarity with UnisonDocumentation writing skills
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Read the three existing comments on this issue for discussion points. Look at the current README file in the repository (likely at root). Understand the separation of concerns between README and the project's website. Propose a structured outline for the new README, noting the discussion and avoiding duplication with the website.