ankitaggarwal011/PyCNN

Add contributing guidelines to the project

Open

#14 opened on 2016年10月3日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Python (526 stars) (86 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.