From 387d6921a6da94c6d024182d82b831ddcb3f540d Mon Sep 17 00:00:00 2001
From: prubenda <prubenda@redhat.com>
Date: Thu, 25 Feb 2021 10:06:10 -0500
Subject: [PATCH] adding contribute doc

---
 README.md          |  1 +
 docs/contribute.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 docs/contribute.md

diff --git a/README.md b/README.md
index bb872dca..fbc169e1 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,7 @@ Monitoring the Kubernetes/OpenShift cluster to observe the impact of Kraken chao
 ### Contributions
 We are always looking for more enhancements, fixes to make it better, any contributions are most welcome. Feel free to report or work on the issues filed on github. 
 
+[More information on how to Contribute](docs/contribute.md)
 
 ### Community
 Key Members(slack_usernames): paigerube14, rook, mffiedler, mohit, dry923, rsevilla, ravi
diff --git a/docs/contribute.md b/docs/contribute.md
new file mode 100644
index 00000000..7a97a6d5
--- /dev/null
+++ b/docs/contribute.md
@@ -0,0 +1,55 @@
+# How to contribute
+
+Contributions are always appreciated.
+
+How to:
+* [Submit Pull Request](#pull-request)
+* [Fix Formatting](#fix-formatting)
+* [Squash Commits](#squash-commits)
+
+## Pull request
+
+In order to submit a change or a PR, please fork the project and follow instructions:
+```bash
+$ git clone http://github.com/<me>/kraken
+$ cd kraken
+$ git checkout -b <branch_name>
+$ <make change>
+$ git add <changes>
+$ git commit -a
+$ <insert good message>
+$ git push
+```
+
+## Fix Formatting
+You can do this before your first commit but please take a look at the formatting outlined using tox.
+
+To run:
+
+```pip install tox ```(if not already installed)
+
+```tox``` 
+
+Fix all spacing, import issues and other formatting issues
+
+## Squash Commits
+If there are mutliple commits, please rebase/squash multiple commits
+before creating the PR by following:
+
+```bash
+$ git checkout <my-working-branch>
+$ git rebase -i HEAD~<num_of_commits_to_merge>
+   -OR-
+$ git rebase -i <commit_id_of_first_change_commit>
+```
+
+In the interactive rebase screen, set the first commit to `pick` and all others to `squash` (or whatever else you may need to do).
+
+Push your rebased commits (you may need to force), then issue your PR.
+
+```
+$ git push origin <my-working-branch> --force
+```
+
+
+