khuedoan-homelab/docs/reference/contributing.md
2022-10-25 18:26:06 +07:00

808 B

Contributing

How to contribute

Bug report

You can create a new GitHub issue with the bug report template.

Submitting patches

Because you may have a lot of changes in your fork, you can't create a pull request directly from your master branch. Instead, create a branch from the upstream repository and commit your changes there:

git remote add upstream https://github.com/khuedoan/homelab
git fetch upstream
git checkout upstream/master
git checkout -b contrib-fix-something

# Make your changes here
#
# nvim README.md
# git cherry-pick a1b2c3
#
# commit, push, etc. as usual

Then you can send the patch using GitHub pull request or git send-email to mail@khuedoan.com.