oakmac/cuttle

Cuttle should have a guide to contribution

Open

#100 建立於 2015年2月25日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)JavaScript (316 star) (11 fork)batch import
enhancementhelp wanted

描述

We should encourage contribution by giving some instructions for regulars tasks.

Off the top of my head I can think about topics like:

  • Versioning
  • Acceptance Workflow / Criteria
  • Documentation

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Review the existing project structure and any existing docs. Look at how other open source projects structure their CONTRIBUTING.md. Focus on the topics mentioned: versioning, acceptance workflow/criteria, documentation. The guide should be written in a clear, welcoming tone for first time contributors.