diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..df9a0fd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,69 @@ +# 🌱 Contributing to Octet Learnings App + + +### Welcome to Octet Learnings App Public Repository. 👨🏻‍💻 + +

A month-long celebration from October 1st - 31st sponsored by Digital Ocean and GitHub to get people involved in Open Source. Create your very first pull request to any public repository on GitHub and contribute to the open source developer community. + +https://hacktoberfest.digitalocean.com/

+ +--- + +### What can You contribute ⚠️ + +- There are functionality specific folders in the repository choose any you're comfortable with if not, make one. +- Inside the client -> components folder there will be multiple folders of their respective pages. +- Inside the client -> context folder there are the ways how the smart contracts are fetched and even shows you how to connect your metamask wallet. +- Inside the Smart contracts folder there is the solidity code where the smart contract is developed. +- Make sure your follow the below steps. + +--- + +### Process are as follows :- + +- Login using github @ [Hacktoberfest](https://hacktoberfest.digitalocean.com/) +- Create four valid pull requests (PRs) between 1st - 31st October + +--- + +### How to Contribute to this repository + +- Fork the repository (Click the Fork button in the top right of this page, click your Profile Image) +- Clone the forked repository to your local machine. + +```markdown +https://github.com/Octet3290/OctetLearnings.git +``` + +- change the present working directory + +```markdown +cd OctetLearnings +``` + +- Add/Create your project to the specific folder as described in what you can contribute section. +- Make a new branch + +```markdown +git checkout -b branch-name +``` + +- Make change in the repository with the new branch. +- push the changes. + +```markdown +git add . +git commit -m "Your commit Message" +git push origin branch-name +``` + +- Make a pull request. +- Star the repository. + +### NOTE + +- Make Sure you commit your changes in a new branch. +- Make Sure you Give proper name to your files describing the addition. +- Also Make Sure you comment your code whereever necessary. + +