Add contributing guidelines to the project

Question

Add contributing guidelines to the project

ankitaggarwal011 opened this issue 8 years ago · comments

Ankit Aggarwal commented 8 years ago

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.

Sumant Bagade · Answer 1 · Tue Oct 04 2016 03:24:36 GMT+0800 (China Standard Time)

Looks interesting.

Abhishek · Answer 2 · Thu Oct 06 2016 22:15:46 GMT+0800 (China Standard Time)

Doing it 👍
The overview is already in the README file so I guess we can leave it in the contribution.md?

Ankit Aggarwal · Answer 3 · Thu Oct 06 2016 22:39:57 GMT+0800 (China Standard Time)

Thank you for your interest @vibrantabhi19. I appreciate it. @skinnejj was already working on this in #16. Please take a look at it. This issue can have multiple contributors. Thank you.

Edit: It might be better to document the overview of code structure and API can be written in a separate document rather than this. You can leave that section at this time. Thank you.