From fe582ac635edd9544fa8a21d050a98c591da0f75 Mon Sep 17 00:00:00 2001 From: kota kanbe Date: Thu, 19 Jul 2018 10:04:31 +0900 Subject: [PATCH] Change GitHub templates --- .github/ISSUE_TEMPLATE.md | 46 +++++++++++++++++--------------- .github/PULL_REQUEST_TEMPLATE.md | 28 ++++++++++++++----- 2 files changed, 46 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 51f9b478..073442e7 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,7 +1,26 @@ -# Environment +# What did you do? (required. The issue will be **closed** when not provided.) -## Vuls + +# What did you expect to happen? + + +# What happened instead? + +* Current Output + +Please re-run the command using ```-debug``` and provide the output below. + +# Steps to reproduce the behaviour + + +# Configuration (**MUST** fill this out): + +* Go version (`go version`): + +* Go environment (`go env`): + +* Vuls environment: Hash : ____ @@ -9,28 +28,11 @@ To check the commit hash of HEAD $ vuls -v or + $ cd $GOPATH/src/github.com/future-architect/vuls $ git rev-parse --short HEAD -## OS -- Target Server: Write here -- Vuls Server: Write here - -## Go -- Go version: here - -# Current Output - -Please re-run the command using ```-debug``` and provide the output below. - -# Addition Details - -Can you also please fill in each of the remaining sections. - -## Expected Behavior - -## Actual Behavior - -## Steps to reproduce the behaviour +* config.toml: +* command: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2bb322f7..5bd98af2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,26 @@ -## What did you implement: -Closes #XXXXX +If this Pull Request is work in progress, Add a prefix of “[WIP]” in the title. -## How did you implement it: +# What did you implement: +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -## How can we verify it: +Fixes # (issue) +## Type of change -## Todos: +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. + +# Checklist: You don't have to satisfy all of the following. - [ ] Write tests @@ -21,4 +33,8 @@ You don't have to satisfy all of the following. - [ ] Update the messages below ***Is this ready for review?:*** NO -***Is it a breaking change?:*** NO + +# Reference + +* https://blog.github.com/2015-01-21-how-to-write-the-perfect-pull-request/ +