Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.44 KB

Contributing

First off, thank you for considering contributing to KCD Australia! It's people like you who make the community great.

This document lays out how to get you started in contributing to KCD Australia, so please read on.

Fork Repositories and work in a branch

  • Branch away from the main branch and use the following schema for naming your branches:
<github-issue-number>/<descriptive-name-with-dashes>

Example:
1/add-logo

Commiting code

git add .
git commit -m "add x" -s
git push

Make a Pull Request

At this point, you should switch back to the main branch in your repository, and make sure it is up to date with main branch of kcd-website:

git remote add upstream git@github.com:kcd-australia/kcd-website.git
git checkout main
git pull upstream main

Then update your feature branch from your local copy of main and push it:

git checkout 1/add-logo
git rebase master
git push --set-upstream origin 1/add-logo

Finally, go to GitHub and create a Pull Request.