Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. But it is also important to follow the best practices so that there is no confusion.
For beginners, who are starting out with their first contributions, it might seem a bit tricky to work with GitHub, especially if you have no previous knowledge of Git.
So, here are a couple of resources to help you refresh / get started:
PyAutoCode relies on Python as its core language. It also makes use of machine learning (ML) concepts.So, inorder to make contributions, you are expected to know the basics of Python as well as ML. For Python, this is a great playlist to start with. For machine learning concepts, refer this website
PyAutoCode is evolving at a very fast rate. So many changes are being made to make it adaptive and upto date. This means, we change/update our documentations very often. Keeping a proper and neat documentation is what we are after. For those contributing towards documentation, knowing Markdown will be of great help.
Here are some resources for you to get started:
You are free to choose your style of workflow as far as you are not making a PR from the main branch of your fork. This is not recommended and would create some problems while syncing your fork with the upstream repository.
For beginners, here's what you'd have to do:
- Fork the Project
- Clone your fork to your local machine via
git clone https://github.com/P0intMaN/PyAutoCode.git - Create a branch in your local machine:
git checkout -b <branchname> - Make changes/commits to this branch
- Push changes to your fork:
git push origin <branchname> - Open a PR from your fork to PyAutoCode main branch
We love our commits to look similar and homogeneous. We recently started following conventionalcommits guidelines to craft our commit messages. You too can follow this guide at https://www.conventionalcommits.org/