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.
Add contributing guidelines to the project · ankitaggarwal011/PyCNN#14 | Good First Issue