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.