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 (86 forks)batch import
documentationeasyhacktoberfesthelp wanted

Repository metrics

Stars
 (526 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the current repository structure, identify key areas like codebase organization, testing, and API documentation, then draft contributing guidelines following best practices from similar open source projects.
Tech stack
python
Domain
computer visiondocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90