How to Contribute
In order to allow multiple people to participate in the improvement of this project, we are making use of git's branch functionality, however, due to the issues that it can sometimes cause, we will not be making use of gitflow, nevertheless, you should follow the indications bellow before even attempting to contribute.
Every new feature/addition should have its own branch, so that after it's done and reviewed it can be merged with master/dev.
To start your own branch, head to the main repository page here on GitHub, click the Branch button:
Now you should assure that you are on the master branch, if so, proceed to search the name of the new branch you want to create, and click Create Branch:
You should now see that you are on your new branch:
Once you've done this, you can return to your local directory for the project, right-click inside the folder and open git bash:
From then, run git fetch, to get the latest branches and updates from the remote source:
Finally, checkout the branch you just created via git checkout {branchName}:
You are now setup and ready to code!
Once you have made some headway into your new feature, you should commit the code to the remote branch, in order to do this, save your work, and open git bash again.
Once you've opened it run git add . to stage all modified files for committing:
Proceed to commit these changes to origin using git commit -m {commitMessage}:
Finally, push the changes to the remote branch:
Now you can keep coding without the fear of losing your progress!
If you've completed your work and pushed the final changes to Github, you can now proceed to open a pull request up for review.
To do so, head to the GitHub page for the project, and you should see a yellow bow with the branch's name and a green button on the left:
Click the button, and you will be prompted to open a pull request, fill in the necessary details describing what the pull request contains, and hit Create Pull Request:
Once this is done, the CODEOWNERS will review your request, and merge it with master!