From 8d3889fb4b696d78adcc619ab9e4b0f6b2c0ebbf Mon Sep 17 00:00:00 2001 From: Pradumna Saraf Date: Thu, 27 Jul 2023 20:25:46 +0530 Subject: [PATCH] docs: Add COC --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b33ed6a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +Sure! Here's the modified contribution guide for the repository [OpenSource-API](https://github.com/Pradumnasaraf/candy): + +> IMPORTANT **Note** +> +> **Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.** + +## 👨‍💻 Prerequisite + +#### Documentation + +- [Git](https://git-scm.com/) +- [Markdown](https://www.markdownguide.org/basic-syntax/) + +#### Code + +- [Golang](https://golang.org/) +- [Cobra](https://github.com/spf13/cobra) +- [Viper](https://github.com/spf13/viper) + +## 💥 How to Contribute + +- Look at the existing [**Issues**](https://github.com/Pradumnasaraf/candy/issues) or [**create a new issue**](https://github.com/Pradumnasaraf/candy/issues/new/choose)! +- [**Fork the Repo**](https://github.com/Pradumnasaraf/candy/fork). Then, create a branch for any issue that you are working on. Finally, commit your work. +- Create a **[Pull Request](https://github.com/Pradumnasaraf/candy/compare)** (_PR_), which will be promptly reviewed and given suggestions for improvements by the community. +- Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR. + +Please note that the above instructions assume familiarity with Git, Markdown, Node.js, and NPM. If you need any assistance or have further questions, feel free to ask. Happy contributing!