Configuring your editor to use our lint and code style rules will help make the code review process delightful!
Configure your editor to use our ESLint
configurations.
Configure your editor to use our editor configurations.
ext install EditorConfig
The process of submitting a pull request is fairly straightforward and generally follows the same pattern each time:
- Create a feature branch
- Make your changes
- Rebase
- Check your submission
- Create a pull request
- Update the pull request
git checkout main
git pull origin main
git checkout -b <name-of-the-feature>
Modify the files, build, test, lint and eventually commit your code using the following command:
git add <path/to/file/to/commit>
git commit
git push origin <name-of-the-feature>
The above commands will commit the files into your feature branch. You can keep pushing new changes into the same branch until you are ready to create a pull request.
Sometimes your feature branch will get stale with respect to the main branch, and it will require a rebase. The following steps can help:
git checkout main
git pull origin main
git checkout <name-of-the-feature>
git rebase main <name-of-the-feature>
note: If no conflicts arise, these commands will ensure that your changes are applied on top of the main branch. Any conflicts will have to be manually resolved.
yarn run lint
The above command may display lint issues that are unrelated to your changes. The recommended way to avoid lint issues is to configure your editor to warn you in real time as you edit the file.
Fixing all existing lint issues is a tedious task so please pitch in by fixing the ones related to the files you make changes to!
yarn test
If you've never created a pull request before, follow these instructions.
git fetch origin
git rebase origin/${base_branch}
# If there were no merge conflicts in the rebase
git push origin ${feature_branch}
# If there was a merge conflict that was resolved
git push origin ${feature_branch} --force
note: If more changes are needed as part of the pull request, just keep committing and pushing your feature branch as described above and the pull request will automatically update.