Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (49 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

73 lines (49 loc) · 1.44 KB

How to contribute

You can use your preferred git workflow but i'll recommend using worktrees.

Here's a quick guide on how to contribute using worktrees :

First, create a new folder in your computer

mkdir ./moviematcherdotcom &&
cd ./moviematcherdotcom

Then, fork the main branch

You only need to do this the first time

how-to-fork

# Clone your fork
git clone git@github.com:[YOURUSERNAME]/moviematcher.com.git &&
cd ./moviematcher.com

Creating a worktree

# Creates a worktree outside the main branch and a new branch
git worktree add ../feature-header -b feat/header

Working in a worktree

# in main
cd ../feature-header
# ... code ...
git add .
git commit -m "feat: header"
git push -u origin feat/header
# → PR on GitHub

Deleting a worktree (after merging a PR)

# 1. Merge on github
# 2. Update main
cd ../main
git pull

# 3. Delete the worktree and local branch
git worktree remove ../feature-header
git branch -d feat/header

After you've finished and tested your awesome feature, you can submit your pull request by creating a new one on the original repository.

You can now start working and submitting your branches !

Branches

For better naming of your branches, please use the following prefixes :

  • feat/ (for features)
  • fix/ (for fixes)
  • docs/ (when updating documentation)
  • ui/ (for ui/ux changes)