diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..67952c7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# Welcome To frytheweb Contribution Guide! 🥳 + +## Getting started and Making A Pull Request + +**Fork The Repository by clicking the fork button** + +**Clone the repository:** +``` bash +git clone https://github.com/virtual-tech-school/frytheweb +``` + +**Navigate into the repository :** +``` bash +cd frytheweb +``` + +**Create a new branch:** +```bash +git branch +git checkout +``` + +**Make the necessary changes** + +**Add changes made to the staging area:** +```bash +git add +``` + +**Commit Changes** +```bash +git commit -m"" +``` +**Push Changes** +```bash +git push origin +``` + +**Create a Pull Request** + + +**NOTE:** Please make sure to follow the given [Semantic Commit Message Convention](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716) + +## Discussions + +- Have a question? Want to discuss a feature? [Start a discussion](https://github.com/virtual-tech-school/frytheweb/discussions) + + We welcome any discussions and questions. We want to make sure that Reflex is the best it can be, and we can't do that without your help. + +## Issues + +* ### Create a new issue + + If you spot a problem with anything in the repository, please feel free to create an issue. Even if you are not sure if its a problem with the framework or your own code, create an issue and we will do our best to answer or resolve it. + +* ### Solve an issue + + Scan through our [existing issues](https://github.com/virtual-tech-school/frytheweb/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, please make sure to get it assigned to you by the respective maintainer and submit the corresponding fix. + +**Thank you for supporting frytheweb !🎊**