ankitaggarwal011/PyCNN

Add contributing guidelines to the project

Open

#14 opened on Oct 3, 2016

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (526 stars) (86 forks)batch import
documentationeasyhacktoberfesthelp wanted

Description

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.

Contributor guide

Tech stack
python
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.