Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1020 Bytes

File metadata and controls

28 lines (18 loc) · 1020 Bytes

Contributing

Follow these steps when contributing to the repo! Make sure you have cloned the repo and are all set to go.

Making Changes

Before you start making changes, always make sure you're on the main branch.

  1. Make sure your code is up to date with git pull
  2. Create a new branch with git checkout -b <name-of-branch>
  3. Make your changes

Commiting Changes

Using git or your choice of preference, follow these steps (assuming you have done the above).

  1. git add . (to stage all files) or git add <file-name> (to stage specific file)
  2. git commit -m "<type>: <description>" using conventional commit messages
  3. git push -u origin <name-of-branch>

Making Pull Requests

After pushing, go to the project repo on Github

  1. Create a new pull request and fill out the PR template
  2. Make sure your PR is linked to the corresponding issue
  3. Request a reviewer to check out your code
  4. Once approved, your code is ready to be merged!