From 3c372f34e4d8b24957ea9926835f23e4ccaed2bf Mon Sep 17 00:00:00 2001 From: Chong Guo Date: Sun, 12 Aug 2018 18:09:18 -0700 Subject: [PATCH] Docs(github): update github related docs --- .github/ISSUE_TEMPLATE.md | 21 +++++++++++-------- .github/PULL_REQUEST_TEMPLATE.md | 35 ++++++++++++++------------------ 2 files changed, 27 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 5f474d4..932cc25 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -4,16 +4,19 @@ PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATI ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION. --> -# I'm submitting a + - +# I'm submitting a -[ ] Bug report -[ ] Feature request -[ ] Performance issue -[ ] Regression (a behavior that used to work and stopped working in a new release) -[ ] Documentation issue or request -[ ] Other... Please describe: + ## Current behavior @@ -29,7 +32,7 @@ ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION. For bug reports please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via github repo or similar tools. --> -## What is the motivation / use case for changing the behavior? +## What is the motivation / use case for changing the behavior diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 538e240..c2ae648 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,30 +4,25 @@ https://github.com/Armour/Magic-Tower-Qt/blob/master/.github/CONTRIBUTING.md#sub --> - -**What kind of change does this PR introduce?** (check at least one) +**Make sure the PR fulfills these requirements:** -- [ ] Bugfix -- [ ] Feature -- [ ] Code style update -- [ ] Refactor -- [ ] Build-related changes -- [ ] Other, please describe: +- When resolving a specific issue, make sure it's referenced in the PR's title (e.g. `Closes #xxx[,#xxx]`, where "xxx" is the issue number) -**Does this PR introduce a breaking change?** (check one) +- If adding a **new feature**, the PR's description includes: A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it) -- [ ] Yes -- [ ] No +- If this PR introduce a **breaking change**, please describe the impact and migration path for existing applications -If yes, please describe the impact and migration path for existing applications: +**What kind of change does this PR introduce?** -**The PR fulfills these requirements:** - -- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `Closes #xxx[,#xxx]`, where "xxx" is the issue number) - -If adding a **new feature**, the PR's description includes: - -- [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it) + -**Other information:** +**More information:**