Skip to content

Contribution Guide

murtaza64 edited this page Oct 10, 2021 · 1 revision

Hi!

To contribute to this repo, please stick to the following guidelines.

  1. Choose an issue and assign yourself to it
  2. Create a new branch, named sensibly based on which work you are going to do
  3. Make changes 👩‍💻
  4. Once your branch has all the necessary changes committed, push to remote and create a pull request. Reference the issue in your pull request (Optional at this step: merge in changes from remote master in case some other PRs have been merged in this time. This helps maintainers merge your commit with fewer conflicts.)
  5. Optional: try and resolve the merge conflicts if there are any (if you can't, a maintainer will do it)
  6. Wait for the maintainers to merge the pull requests

GitHub desktop and command line git both work fine for doing most of the workflow, but VSCode is useful for resolving merge conflicts. Opening VSCode in your local repo will show files that have conflicts with a red ! and allow you to use the UI to select which changes to keep.

😃

Clone this wiki locally