[feat]:Mentor-Guide added (#4)

Sonichigo · web-flow · commit 772d0166b1ba · 2023-02-17T12:02:08.000+05:30
Signed-off-by: sonichigo &lt;kurosakiichigo.songoku@gmail.com&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,27 +1,102 @@
 # Contributing to Keploy
 
-Thank you for your interest in Keploy and for taking the time to contribute to this project. 🙌
-Keploy is a project by developers for developers and there are a lot of ways you can contribute.
+Thank you for your interest in Keploy and for taking the time to contribute to this project. 🙌 Keploy is a project by developers for developers and there are a lot of ways you can contribute.
+
 If you don't know where to start contributing, ask us on our [Slack channel](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA).
 
 ## Code of conduct
 
-Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing
+Contributors are expected to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Prerequisites for the contributors
+
+Contributors should have knowledge of git, go, and markdown for most projects since the project work heavily depends on them.
+We encourage Contributors to set up Keploy for local development and play around with the code and tests to get more comfortable with the project. 
+
+Sections
+
+- <a name="contributing"> General Contribution Flow</a>
+  - <a name="#commit-signing">Developer Certificate of Origin</a>
+- <a name="contributing-keploy">Keploy Contribution Flow</a>
+  - <a name="keploy-server">Keploy Server</a>
+  - <a name="keploy-docs">Keploy Documentation</a>
+  - <a name="keploy-sdks">Keploy SDK Integration</a>
+
+# <a name="contributing">General Contribution Flow</a>
+
+## <a name="commit-signing">Signing-off on Commits (Developer Certificate of Origin)</a>
+
+To contribute to this project, you must agree to the Developer Certificate of
+Origin (DCO) for each commit you make. The DCO is a simple statement that you,
+as a contributor, have the legal right to make the contribution.
+
+See the [DCO](https://developercertificate.org) file for the full text of what you must agree to
+and how it works [here](https://github.com/probot/dco#how-it-works).
+To signify that you agree to the DCO for contributions, you simply add a line to each of your
+git commit messages:
+
+```
+Signed-off-by: Jane Smith <jane.smith@example.com>
+```
+
+In most cases, you can add this signoff to your commit automatically with the
+`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email
+address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:
+
+```
+$ commit -s -m “my commit message w/signoff”
+```
+
+To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`:
+
+_~/.gitconfig_
 
-## How can I contribute?
+```
+[alias]
+  amend = commit -s --amend
+  cm = commit -s -m
+  commit = commit -s
+```
+
+## <a name="contributing-keploy">Keploy Contribution Flow</a>
+
+Keploy is written in `Go` (Golang) and leverages Go Modules. Relevant coding style guidelines are the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments) and the _Formatting and style_ section of Peter Bourgon's [Go: Best
+Practices for Production Environments](https://peter.bourgon.org/go-in-production/#formatting-and-style).
 
 There are many ways in which you can contribute to Keploy.
 
-#### 🐛 Report a bug
+###  <a name="keploy-server">Keploy Server</a>
+
+#### Report a Bug
 Report all issues through GitHub Issues using the [Report a Bug](https://github.com/keploy/keploy/issues/new?assignees=&labels=&template=bug_report.md&title=) template.
 To help resolve your issue as quickly as possible, read the template and provide all the requested information.
 
-#### 🛠 File a feature request
+#### Feature request
 We welcome all feature requests, whether it's to add new functionality to an existing extension or to offer an idea for a brand new extension.
 File your feature request through GitHub Issues using the [Feature Request](https://github.com/keploy/keploy/issues/new?assignees=&labels=&template=feature_request.md&title=) template.
 
-#### 📝 Improve the documentation
-In the process of shipping features quickly, we may forget to keep our docs up to date. You can help by suggesting improvements to our documentation using the [Documentation Improvement](https://github.com/keploy/docs/issues) template!
+#### Close a Bug
+We welcome contributions that help make keploy bug free & improve the experience of our users. You can also find issues tagged [Good First Issues](https://github.com/keploy/keploy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+
+###  <a name="keploy-docs">Keploy Documentation</a>
+
+The Keploy documentation site uses Docusaurus 2, which is a static website generator, you can make changes locally without previewing them in the browser.
+
+In the process of shipping features quickly, we may forget to keep our docs up to date. You can help by suggesting improvements to our documentation using the [Documentation Improvement](https://github.com/keploy/docs/issues) template. 
+
+Please refer to [Keploy Docs Contributing Guide](https://github.com/keploy/docs/blob/main/CONTRIBUTING.md#-how-to-set-up-the-docs-website-locally) for setting up your development environment and the follow [Keploy Style Guide](https://github.com/keploy/docs/blob/main/STYLE.md).
+
+###  <a name="keploy-sdks">Keploy SDKs</a>
+
+Keploy provides stable support for ``Go``, ``Java``  and ``Ts`` language based applications. 
+
+- [x] [Go SDK](https://github.com/keploy/go-sdk)
+- [x] [Java SDK](https://github.com/keploy/java-sdk)
+- [x] [TypeScript SDK](https://github.com/keploy/typescript-sdk)
+
+Every SDKs support the popular and common Routers and Databases.
+
+
+# Contact
 
-#### ⚙️ Close a Bug / Feature issue
-We welcome contributions that help make keploy bug free & improve the experience of our users. You can also find issues tagged [Good First Issues](https://github.com/keploy/keploy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+Feel free to join [slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA) to start a conversation with us.
diff --git a/MENTOR-GUIDE.md b/MENTOR-GUIDE.md
@@ -0,0 +1,19 @@
+# Mentor guide
+## External resources for mentors
+[GSoC’s mentor guide](https://google.github.io/gsocguides/mentor/)
+
+## Why become a mentor?
+As a mentor you get the opportunity to mentor a newbie in open source on your favourite project.
+
+## How to become a mentor?
+There are 3 steps to becoming a GSoC mentor:
+* Propose a project (make sure you have the green light from your manager on the time commitment)
+* Interact with students in the student application phase, answer their questions and help them develop their applications
+* Review student applications to your organization and project. Select a student(s) to work with you!
+
+## What is expected of a mentor?
+As a mentor you have the following responsibilities:
+* Carefully plan out a project, expectations, deliverables with the student you take on. 
+* Make sure you have enough experience with the project you’re proposing.
+* Mentor the student throughout the code period, making sure they have a good development/testing setup and  a good way to get started.
+* Review their progress regularly.
diff --git a/README.md b/README.md
@@ -3,13 +3,66 @@
 [![Slack](.github/slack.svg)](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
 [![License](.github/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-# Keploy
+# About Keploy
 Keploy is a no-code testing platform that generates tests from API calls. 
 
 It captures the external dependency network calls (like database queries, internal/external services) for each request to replay them (including writes/mutations!) later during testing. 
 
 Developers can use keploy alongside their favorite unit testing framework to save time writing testcases.  
 
+# Keploy + Google Summer of Code, 2023
+This is the main place for all information related to Keploy's participation in Google Summer of Code, 2023 as a mentoring organization.
+
+## What is Google Summer of Code?
+
+[Google Summer of Code](https://summerofcode.withgoogle.com/) is a 16 years old program, run every summer, with the intention of bringing more students into open source. 
+
+Open source projects apply as mentor organizations and if they are accepted, students send proposals to them to work on a few months' long project. Projects can be planned out by the organizations in advance or can be proposed by students.
+
+Google pays the students, not the organizations they work with. Beginning in 2023, Google is opening the program up to all newcomers of open source that are 18 years and older.
+
+You can read more about the format of the program and its goals [here](https://google.github.io/gsocguides/mentor/).
+
+
+## What is the timeline for GSoC 2023?
+[Full timeline](https://summerofcode.withgoogle.com/programs/2023)
+
+|Important events | Deadline|
+| ----- | ----- |
+| Organization Applications Open | January 23, 2023|
+| Organization Application Deadline | February 7, 2023 |
+| Organizations Announced | February 22, 2023 |
+| Potential GSoC contributors discuss application ideas with mentoring organizations | February 22 - March 20, 2023 |
+| GSoC contributor application period | March 20 - April 4, 2023 |
+| Accepted GSoC Contributor projects announced | May 4, 2023 |
+| Students work on their Google Summer of Code project | May 4, 2023 - NOvember 17, 2023|
+
+#### Statistics
+- Since year 2005, 16,000+ students and 13000 mentors from over 118 countries has came together to participate in GSoC
+- Approximately 38+ million lines of code have been produced
+
+---
+
+# Additional Information
+
+## Who can propose a project and who can be a mentor?
+
+Keploy members and members from the wider community can both propose projects, however, only Keploy members can be mentors.
+
+## What is expected of a mentor?
+Please read [The Mentor Guide](MENTOR-GUIDE.md).
+
+## Information for applying students
+
+Students should have knowledge of git, go, and markdown for most projects since the project work heavily depends on them.
+
+We invite students to look into [our open proposals](https://github.com/keploy/gsoc/tree/main/2023), ask mentors questions to understand the projects better and if interested apply for the project when the application period opens.
+
+Mentors would like to know why the project interests the student, whether they have the pre-requisite skills, and most importantly, how they plan to implement it.
+
+We encourage Contributors to set up Keploy for local development and play around with the code and tests to get more comfortable with the project. 
+
+
 ## Community support
 We'd love to collaborate with you to make Keploy great. To get started:
 * [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA) - Discussions with the community and the team.
