Step 1. Fork a copy from g to your GitHub repository

Screen Shot 2021-12-07 at 8.37.26 PM.png

Untitled

Step 2. Clone the LightDance-Editor to your local machine

# USERNAME – your Github user account name.
git clone git@github.com:${USERNAME}/LightDance-Editor.git

cd LightDance-Editor 
# set upstream
git remote add upstream git@github.com:NTUEELightDance/LightDance-Editor.git

# Don't push to the upstream main
git remote set-url --push upstream no_push

# check your setup
git remote -v

Screen Shot 2021-12-07 at 9.02.37 PM.png

Step 3. Create a Github Issue on NTUEELightDance/LightDance-Editor

沒錢用 Jira,只好用 Github Issues

Untitled

Untitled

Untitled

Submit 後可以到 https://github.com/orgs/NTUEELightDance/projects/1 連結去看

Untitled

Screen Shot 2021-12-07 at 9.20.28 PM.png

Screen Shot 2021-12-07 at 9.21.02 PM.png

Step 4. Create a local branch for your contribution

cd LightDance-Editor

# Make your local main up-to-date
git checkout main
git fetch upstream
git rebase upstream/main

# You can check your local commits
# make sure they are the same as the remote NTUEELightDance/LightDance-Editor repo
	git log -- oneline

# Create a new branch for the new issue EDITOR-#{ISSUE_ID}
	git checkout -b EDITOR-#{ISSUE_ID}
	# Example
# git checkout -b EDITOR-#9   

Step 5. Develop & Create commits

git add ${edited files}
git commit -m "EDITOR-#{ISSUE_ID} ${Commit Message}"
# Example
# git commit -m "EDITOR-#9. Update pull_request_template"

gmareStep 6. Sync your local branch with upstream/main