From 6f812cfcb6360d27fe5e749b99fe96e634b5c4c9 Mon Sep 17 00:00:00 2001 From: Aitthi Arsa Date: Sun, 21 Feb 2021 14:18:53 +0700 Subject: [PATCH 1/2] feat(docs): added pull_request_template.md --- .github/PULL_REQUEST_TEMPLATE.md | 40 ++++++++++++++ CONTRIBUTING.md | 90 ++++++++++++++++++++++++++++++++ 2 files changed, 130 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e94c716 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,40 @@ +## PR Checklist +Please check if your PR fulfills the following requirements: + +- [ ] The PR follows our guidelines: https://github.com/thananon/twitch_tools/blob/main/CONTRIBUTING.md +- [ ] Tests for the changes have been added (for bug fixes / features) +- [ ] Docs have been added / updated (for bug fixes / features) + + +## PR Type +What kind of change does this PR introduce? + +Please check the one that applies to this PR using "x". +``` +[ ] Bugfix +[ ] Feature +[ ] Code style update (formatting, local variables) +[ ] Refactoring (no functional changes, no api changes) +[ ] Documentation content changes +[ ] Other... Please describe: +``` + +## What is the current behavior? + + +Issue Number: N/A + + +## What is the new behavior? + + +## Does this PR introduce a breaking change? +``` +[ ] Yes +[ ] No +``` + + + + +## Other information \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1b77fac --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,90 @@ +# Contributing to 9ArmBot + +We would love for you to contribute to 9ArmBot and help make it even better than it is +today! As a contributor, here are the guidelines we would like you to follow: + + - [Submitting a Pull Request (PR)](#submit-pr) + +### Submitting a Pull Request (PR) +Before you submit your Pull Request (PR) consider the following guidelines: +#### Type +Must be one of the following: + +* **docs**: Documentation only changes +* **feat**: A new feature +* **fix**: A bug fix +* **perf**: A code change that improves performance +* **refactor**: A code change that neither fixes a bug nor adds a feature +* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +## +* Search [GitHub](https://github.com/thananon/twitch_tools/pulls) for an open or closed PR + that relates to your submission. You don't want to duplicate effort. +* Make your changes in a new git branch: + + ```shell + git checkout -b fix/my-fix-branch main + ``` +* Commit your changes using a descriptive commit message that follows our + [commit message conventions](#commit). + + ```shell + git commit -a + ``` + Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + +* Push your branch to GitHub: + + ```shell + git push origin fix/my-fix-branch + ``` + +* In GitHub, send a pull request to `twitch_tools:main`. +* If we suggest changes then: + * Make the required updates. + * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): + + ```shell + git rebase main -i + git push -f + ``` + +That's it! Thank you for your contribution! + +#### After your pull request is merged + +After your pull request is merged, you can safely delete your branch and pull the changes +from the main (upstream) repository: + +* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: + + ```shell + git push origin --delete fix/my-fix-branch + ``` + +* Check out the master branch: + + ```shell + git checkout main -f + ``` + +* Delete the local branch: + + ```shell + git branch -D fix/my-fix-branch + ``` + +* Update your master with the latest upstream version: + + ```shell + git pull --ff upstream master + ``` + + +## Commit Message Guidelines + +``` +docs(changedocs): update change README.md +``` +``` +fix(release): need to depend on latest axios +``` From 7b25531e094485b323ad75d4ff5634b0d77cb6d0 Mon Sep 17 00:00:00 2001 From: Aitthi Arsa Date: Sun, 21 Feb 2021 14:19:08 +0700 Subject: [PATCH 2/2] feat(docs): added pull_request_template.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1b77fac..e04ff0b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,7 @@ from the main (upstream) repository: git push origin --delete fix/my-fix-branch ``` -* Check out the master branch: +* Check out the main branch: ```shell git checkout main -f @@ -73,10 +73,10 @@ from the main (upstream) repository: git branch -D fix/my-fix-branch ``` -* Update your master with the latest upstream version: +* Update your main with the latest upstream version: ```shell - git pull --ff upstream master + git pull --ff upstream main ```