Skip to content

Instantly share code, notes, and snippets.

@EragonJ
Last active August 21, 2019 09:26
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save EragonJ/6710fa0b5330243b2dbc to your computer and use it in GitHub Desktop.
Save EragonJ/6710fa0b5330243b2dbc to your computer and use it in GitHub Desktop.
Tips you need to know when contributing to Mozilla/Gaia

Why this list ?

There are many times we have contributors who want to contribute to Mozilla/Gaia, but we always would meet some new friends who are not so familiar with our working flows and Git.

In spite of keep telling them how to do that every time, I think it would be better to record screencasts about how to do that step by step. By following these instructions, you can easily jump into the ecosystem of Mozilla without too many obstacles.

Please fasten your seatbelt and let's start to hack :)

How to rebase and fix conflicts ?

Because Gaia is a hug project maintained by lots of developers in different timezones at the same time, there might be a high chance that your PR is outdated and you have to make sure to rebase to the latest master, otherwise github would not allow us to merge the PR directly.

We all know this is kinda annoying everytime when someone did the same change on the same file to make you need to fix conflicts, but don't be scared, this happens all the time especially in this kind of large scale project. So please go check the Screencast about how to fix them.

Screencast owner : Yurenju

How to squash commits ?

After getting r+, you may already had made so many commits for the bug. But based on our guideline, we hope each PR can map to each commit and also each bug, it means that there should only be ONE commit for your patch.

The reason why we have to do this is because if your patch (or other's, don't get terrified xD) broke anything like tests, functionalities, UI ... etc. We have to revert the patch as soon as possible. So in such one-commit criteria, we can quickly diagnose the syndrome and find out the patch then revert it with only ONE action.

So please make sure you did sqush commits before merging PR. About how to do that, please check the Screencast here.

Screencast owner : EragonJ

Submit your own screencast below !

Keep updated ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment