Merge pull request #19 from hrmnjt/feature/adding-contributing-guidel…

…ines

Added code of conduct and contributing guidelines

.github/code_of_conduct.md

@@ -0,0 +1,85 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

.github/contributing.md

@@ -0,0 +1,68 @@
+# Contributing to `gokaf`
+
+Thanks for checking out the gokaf. We're excited that you decided to 
+contribute and make gokaf awesome!
+
+Following guidelines can help you figure out where you can best be helpful.
+
+## Table of Contents
+
+- [Types of contributions we're looking for](#types-of-contributions-were-looking-for)
+- [Code of conduct](#code-of-conduct)
+- [How to contribute](#how-to-contribute)
+- [Style guide](#style-guide)
+
+
+## Types of contributions we're looking for
+- Report issues or problems that you face while using gokaf
+- Adding more [examples](../examples)
+- Improving the documentation and developer experience for fellow developers
+
+Interested in making a contribution? Read on!
+
+## Code of conduct
+
+Before we get started, please note that we expect you to follow the open 
+source code of conduct and would appreciate if you abide by them. We in return, 
+promise that we will abide with the same to the best of our capacity.
+
+The code of conduct is adopted from 
+[Contributor Covenant](https://www.contributor-covenant.org/).
+
+## How to contribute
+
+If you'd like to contribute, start by searching through the 
+[issues](https://github.com/acjzz/gokaf/issues) and 
+[pull requests](https://github.com/acjzz/gokaf/pulls) to see 
+whether someone else has raised a similar idea or question.
+
+If you don't see your idea listed, please create an issue and discuss with 
+us. We promise to respond back and help out. In case this is related to any 
+enhancement or addition of core functionality, please discuss the approach 
+before starting to code; we might be working on similar things or have 
+suggestions for you.
+
+We follow the Github - fork and pull workflow. 
+
+1. [Fork the repository](https://help.github.com/en/articles/fork-a-repo) and 
+clone your fork repository - to be named as `origin`
+1. Add the remote repository - `git remote add upstream [email protected]:acjzz/gokaf.git`
+    - In case the repository was already forked, update the develop branch from 
+    the latest merge using 
+    `git checkout develop && git pull upstream develop && git push origin develop` 
+    following the conventions
+1. Create a feature or fix branch - `git checkout -b feature/fooBar`
+1. Commit your changes - `git commit -am 'Feature(fooBar): Add some foo bar'`
+1. Push feature/fix branch to `origin` repository
+1. [Create a new pull request](https://help.github.com/en/articles/creating-a-pull-request) 
+to merge `origin:feature/fooBar` (right side) on `upstream:develop` (left side) 
+while adhering to the checklist and guidelines
+
+While the prerequisites above must be satisfied prior to having your pull 
+request reviewed, the reviewer(s) may ask you to complete additional design 
+work, tests, or other changes before your pull request can be ultimately 
+accepted.
+
+## Style guide
+
+Please format your golang code using `gofmt` tool.