When contributing to this repository, please first ask to be assigned to an issue.
- Navigate to an open issue and ask to be assigned to it
- If someone is already assigned to the issue, you cannot be assigned to it too
- After you are assigned, fork the repository and create a new branch
- Clone your forked copy of the project
git clone https://github.com/[your_username]/breakout-game.git - Navigate to the project directory
cd breakout-game - Make your changes according to the pr guidelines.
- Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository)
git pull upstream main - Create a new branch
git checkout -b [your_branch_name] - Track yout changes
git add . - Commit your changes
git commit -m "[Relevant message]" - Push the committed changes in your feature branch to your remote repo
git push -u origin [your_branch_name] - Create a pull request and wait for it to be reviewed
- Make sure your code is formatted correctly
- Make sure you have tested your code
- Write a detailed description what you added or changed
- Remember to update the README.md if you added or changed something important
- The pull request will be checked and merged if everything is fine
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations 🎉🎉 Now it will be counted as a Countribution ✨.
Once your PR is merged, your contributions will be publicly visible.