From f828f1fb94f2b3cc208bf7ba62e3d6548d3ccdd1 Mon Sep 17 00:00:00 2001 From: Pavan Yalamanchili Date: Thu, 15 Feb 2018 14:00:01 -0800 Subject: [PATCH] Adding issue and pull request templates to comply with twitter OSS policies --- .github/ISSUE_TEMPLATE.md | 13 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..ef3b9bc7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ +One line summary of the issue here. + +### Expected behavior + +As concisely as possible, describe the expected behavior. + +### Actual behavior + +As concisely as possible, describe the observed behavior. + +### Steps to reproduce the behavior + +Please list all relevant steps to reproduce the observed behavior. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..bfb079c9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +Problem + +Explain the context and why you're making that change. What is the +problem you're trying to solve? In some cases there is not a problem +and this can be thought of being the motivation for your change. + +Solution + +Describe the modifications you've done. + +Result + +What will change as a result of your pull request? Note that sometimes +this section is unnecessary because it is self-explanatory based on +the solution.