2022-07-06 12:33:35 +07:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
## How to contribute
|
|
|
|
|
|
|
|
|
|
### Bug report
|
|
|
|
|
|
2022-10-01 11:53:18 +07:00
|
|
|
You can [create a new GitHub issue](https://github.com/khuedoan/homelab/issues/new/choose) with the bug report template.
|
2022-07-06 12:33:35 +07:00
|
|
|
|
2022-10-25 18:26:06 +07:00
|
|
|
### Submitting patches
|
2022-07-06 12:33:35 +07:00
|
|
|
|
2022-10-25 18:26:06 +07:00
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
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](https://github.com/khuedoan/homelab/pulls) or `git send-email` to <mail@khuedoan.com>.
|
