Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contributing guidelines to the project #14

Open
ankitaggarwal011 opened this issue Oct 3, 2016 · 3 comments
Open

Add contributing guidelines to the project #14

ankitaggarwal011 opened this issue Oct 3, 2016 · 3 comments

Comments

@ankitaggarwal011
Copy link
Owner

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.

@Subway19
Copy link

Subway19 commented Oct 3, 2016

Looks interesting.

@iabhi7
Copy link

iabhi7 commented Oct 6, 2016

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

@ankitaggarwal011
Copy link
Owner Author

ankitaggarwal011 commented Oct 6, 2016

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants