We will lock the main from bring pushed right away and only allow pull requests.
Requirements for Pull Requests: 1. Github Account 2. Create Branch 3. Pull Request 4. Approval
Please create your github account through here .
We will have 3 different branch types: 1. Feature (Adding a new feature) 2. Update (Removing/Cleanups/Update to a previous feature) 3. Fix (Fixing a bug)
Name the branches according like this:
username/type/what-you-are-doing
Here are some examples:
tamphilip/feature/adding-upvotes
tamphilip/update/cleaning-up-integration-tests
tamphilip/fix/fixing-routes-to-discord
git checkout -b "tamphilip/feature/updating-commit-read-me"
This will automatically create your branch and checkout and now you're ready to work on your feature/update/fix.
Once you are ready to push you can git add everything you've changed (Or specify what files) and then git push your branch to Github.
Add everything:
git commit . ; git push
To specify:
git commit <directory/files> ; git push
It'll ask you to set upstream and then follow the steps to do set the remote.
Don't forget to pull everything from the main branch first and then merge
git pull
git merge main
Once this is done feel free to make your pull request
Update the description according to the template and you're ready for approval.
Now wait for approval and make updates if necessary asked to and merge when you can!