First off, thank you for considering contributing to Free File. It's people like you that make Free File such a great tool.
If you've noticed a bug or have a feature request, make sure to check our Issues to see if someone else in the community has already created a ticket. If not, go ahead and make one!
If this is something you think you can fix, then fork Free File and create a branch with a descriptive name.
A good branch name would be (where issue #325 is the ticket you're working on):
git checkout -b 325-add-japanese-localisationAt this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first.
Your patch should follow the same conventions & pass the same code quality checks as the rest of the project.
At this point, you should switch back to your develop branch and make sure it's up to date with Free File's develop branch:
git remote add upstream [email protected]:simonpham/free_file.git
git checkout develop
git pull upstream developThen update your feature branch from your local copy of develop, and push it!
git checkout 325-add-japanese-localisation
git rebase develop
git push --set-upstream origin 325-add-japanese-localisationGo to the Free File repo and press the "Compare & pull request" button.
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
A PR can only be merged into develop by a maintainer if:
- It is passing CI.
- It has been approved by at least two maintainers. If it was a maintainer who opened the PR, only one extra approval is needed.
- It has no requested changes.
- It is up to date with current develop.
Any maintainer is allowed to merge a PR if all of these conditions are met.