From f342ab42346d2a25622cb1ab027bf438fc1a2da3 Mon Sep 17 00:00:00 2001 From: Scott Mitchell Date: Wed, 30 Nov 2016 17:34:14 -0800 Subject: [PATCH] Use GitHub Issue/PR Template Feature Motivation: GitHub recently added the ability to setup PR and Issue templates https://github.com/blog/2111-issue-and-pull-request-templates. We should take advantage of this feature to ensure Issues / PRs are properly formed. Modifications: - add a .github directory with a CONTRIBUTING.md, ISSUE_TEMPLATE.md, and PULL_REQUEST_TEMPLATE.md file Result: Fixes https://github.com/netty/netty/issues/6074. --- .github/CONTRIBUTING.md | 1 + .github/ISSUE_TEMPLATE.md | 13 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++++ 3 files changed, 28 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..81c2ceabb9 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1 @@ +Please review the [guidelines for contributing](http://netty.io/wiki/developer-guide.html) for this repository. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..a7a6188615 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ +### Expected behavior + +### Actual behavior + +### Steps to reproduce + +### Minimal yet complete reproducer code (or URL to code) + +### Netty version + +### JVM version (e.g. `java -version`) + +### OS version (e.g. `uname -a`) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..17b3725815 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +Motivation: + +Explain here the context, and why you're making that change. +What is the problem you're trying to solve. + +Modification: + +Describe the modifications you've done. + +Result: + +Fixes #. + +If there is no issue then describe the changes introduced by this PR.