ankitaggarwal011/PyCNN

Add contributing guidelines to the project

Open

#14 创建于 2016年10月3日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Python (526 star) (86 fork)batch import
documentationeasyhacktoberfesthelp wanted

描述

This will make things easier for the contributors.

Some important points to be highlighted in the contributing guide would be:

  • How to contribute - improve documentation/add new methods/improve performance.
  • Explain contribution workflow - issues/pull-request/review.
  • An overview of code structure and API.
  • Coding practices to follow.
  • Guide to add a new image processing method.

Any suggestions are welcome. Thanks.

贡献者指南

技术栈
python
领域
documentationdeveloper experience
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
basic Python
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Review the existing repository structure to understand the code organization and API. Check if there are any existing contributing guidelines or documentation files. Look at the comments on the issue for suggestions from other contributors. Consider asking maintainers for clarification on preferred coding practices and contribution workflow.