From 9972553961c80db11494896fa9275915c16a5a81 Mon Sep 17 00:00:00 2001
From: Gaurav Singh <gaurav.singh@go-jek.com>
Date: Tue, 5 Oct 2021 12:25:49 +0530
Subject: [PATCH] Added Contribution guidelines and links on how to build the
 site locally to verify

---
 CONTRIBUTING.md                               | 29 +++++++++++++++++++
 README.md                                     | 18 ++++++++++++
 .../{good-practices => good-practices.md}     |  0
 3 files changed, 47 insertions(+)
 create mode 100644 CONTRIBUTING.md
 rename docs/tech/{good-practices => good-practices.md} (100%)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..3185a9c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,29 @@
+# How to contribute
+
+This site is for the community, by the community. I'm very happy that you want to make the Test
+automation journey easier for the next engineer. 🤝
+
+## To contribute
+
+All the pages are written in markdown and to contribute you would need familiarity with markdown
+syntax. Refer to [this](https://guides.github.com/features/mastering-markdown/) guide from Github
+
+The site is currently divided into two sections
+
+### Community
+
+Lists resources around Testing and automation communities, newsletters, thought leaders to follow
+and amazing podcasts, If you would like to add to it, please raise a PR with the changes and the
+project maintainer will review and get back
+
+### Tech
+
+Lists useful resources around learning different pillars of Test automation such as Web, Mobile,
+Backend automation. Please add relevant links and follow the same workflow
+
+## FAQ
+
+### How do I raise a PR?
+
+Please refer to this guide on
+[Github](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
diff --git a/README.md b/README.md
index 4ddffcb..321dec5 100644
--- a/README.md
+++ b/README.md
@@ -19,3 +19,21 @@ reference to that.
 
 The site is hosted on
 [automationhacks.io/how-to-learn-test-automation/](https://automationhacks.io/how-to-learn-test-automation/)
+
+## How to contribute
+
+Refer to [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## Build locally
+
+If you want to build the site locally, clone this repo and then execute below commands
+
+> Note: You might want to use
+> [pipenv to setup python dependencies](https://automationhacks.io/2020/07/12/how-to-manage-your-python-virtualenvs-with-pipenv/)
+
+```zsh
+# activate pipenv
+pipenv install
+# View from local
+mkdocs serve
+```
diff --git a/docs/tech/good-practices b/docs/tech/good-practices.md
similarity index 100%
rename from docs/tech/good-practices
rename to docs/tech/good-practices.md