Creating code of conduct and contribution guidelines for OpenNoteScanner Android Application.

Repository

https://github.com/ctodobom/OpenNoteScanner

Task Request

OpenNoteScanner provides a way on scanning handwritten notes and printed documents. For this app was no proper guidelines about setup, PR's and creating issues etc for new comers. I proposed to create guideline document for new contributors to the projects and the project owner obliged.

Link to Proposal

Overview

Documents provides the guidelines for commits, PR's, Issues and What are the best practices to follow to be a contributing member of an organization.

I proposed the idea to the project owner after I created a pull request for creating contribution guidelines document I had earlier compiled and the project owner was okay with the idea and gave a go ahead.

Actual content

The documents i created followed common templates that can be found almost anywhere on the internet. However, I worked on a template and modified it's content to suit OpenNoteScanner App. In the document SETUP_GUIDELINES deals with repo setup and CONTRIBUTING has normal code of conduct, best practices, Feature Requests and Bug Reports etc.

Documents

1. SETUP_GUIDELINES.md
2. CONTRIBUTING.md
3. pull_request_template.md and
4. issue_template.md

GitHub Proof of Authorship

• GitHub Account: https://github.com/santoshhiremani
• Link to Merged Documents