Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.54 KB
Raw

Git Workflow

When contributing to this repository, please follow the guidelines below.

Creating your branch

  1. Update the main and dev branches to the latest version.
  2. Create new branch.
  • Do it from the branch it will be merged back into (usually dev).
  • Prefix it with your initials (eg. la/auth).
  1. Work peacefully in your branch.

Pushing changes

  1. Pull dev to the latest version.
  2. Rebase your branch onto dev.
  3. Squash your local commits.
  • You can do it afterwards, but it is advisable to do it before you push it.
  1. Push branch to GitHub (origin with the same name)

Opening a Pull Request

  1. After finishing up your feature, open a Pull Request into the dev branch.
  • Describe what you did with bullet points.
  1. Make sure you added at least unit tests.
  2. If CI passes, ask for someone to review your PR.

Code reviewing

  1. Make sure you follow the language's conventions.
  2. The code owner is responsible for making necessary changes and updating the PR.
  3. Wait for one approval before merging into dev.

Merging Code

  1. Squash and merge the pull request into the dev branch, and delete the branch in the origin.

Branches

main

The main is sacred. The code is always working and is deployable. NEVER work directly on main and never push to it from a local version or from any branch.

dev

The dev is where you branch off and merge in your code. If something does break, you want to fix it as soon as possible.