From ccd72509c673dee1963a8260ee9aff2c319d96cd Mon Sep 17 00:00:00 2001 From: tsuyoshiwada Date: Tue, 20 Feb 2018 23:07:55 +0900 Subject: [PATCH] docs: Add contributing guide and Issues/PR templates --- .github/ISSUE_TEMPLATE.md | 28 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 35 ++++++++++++++++++++++ CONTRIBUTING.md | 50 ++++++++++++++++++++++++++++++++ 3 files changed, 113 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e10b1746 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,28 @@ + + + +## Expected Behavior + +{Please write here} + + +## Actual Behavior + +{Please write here} + + +## Steps to Reproduce (including precondition) + +{Please write here} + + +## Screenshot on This Problem (if possible) + +{Please write here} + + +## Your Environment + +- OS: {Please write here} +- git-chglog version: {Please write here} + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..6de85313 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ + + + +## What does this do / why do we need it? + +{Please write here} + + +## How this PR fixes the problem? + +{Please write here} + + +## What should your reviewer look out for in this PR? + +{Please write here} + + +## Check lists + +* [ ] Test passed +* [ ] Coding style (indentation, etc) + + +## Additional Comments (if any) + +{Please write here} + + +## Which issue(s) does this PR fix? + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5e7184c7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing `git-chglog` + +Thank you for contributing `git-chglog` :tada: + + +## Templates + +Please use issue/PR templates which are inserted automatically. + + +## Found a Bug? + +If you find a bug in the source code, you can help us by [submitting an issue](https://github.com/git-chglog/git-chglog/issues) to our [GitHub Repository](https://github.com/git-chglog/git-chglog). Even better, you can submit a Pull Request with a fix. + + +## Commit Message Format + +A format influenced by [Angular commit message](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-format). + +``` +: + + + +