From 264985868ef5ac009d235b2eb5725b580d2a6cc8 Mon Sep 17 00:00:00 2001 From: Erik Kundt Date: Fri, 27 Jul 2018 13:32:46 +0200 Subject: [PATCH] Adds issue templates for GitHub. --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 37 ++++++++++++++++++ .github/ISSUE_TEMPLATE/general.md | 19 ++++++++++ .../PULL_REQUEST_TEMPLATE.md | 0 4 files changed, 94 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/general.md rename PULL_REQUEST_TEMPLATE.md => .github/PULL_REQUEST_TEMPLATE.md (100%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..196cbb323 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug Report +about: Bug reports about the Solidity Compiler. +--- + +## Prerequisites + +- First, many thanks for taking part in the community. We really appreciate that. +- We realize there is a lot of data requested here. We ask only that you do your best to provide as much information as possible so we can better help you. +- Support questions are better asked in one of the following locations: + - [Solidity chat](https://gitter.im/ethereum/solidity) + - [Stack Overflow](https://ethereum.stackexchange.com/) +- Ensure the issue isn't already reported. +- The issue should be reproducible with the latest solidity version , however, this isn't a hard requirement and being reproducible with an older version is sufficient. + +*Delete the above section and the instructions in the sections below before submitting* + +## Description + +Please shortly describe the bug you have found, and what you expect instead. + +## Environment + +- Compiler version: +- Framework/IDE (e.g. Truffle or Remix): +- EVM execution environment / backend / blockchain client: +- Operating system: + +## Steps to Reproduce + +Please provide a *minimal* source code example to trigger the bug you have found. +Please also mention any command line flags that are necessary for triggering the bug. +Provide as much information as necessary to reproduce the bug. + +``` +// Some *minimal* Solidity source code to reproduce the bug. +// ... +``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..6b98fb99b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,37 @@ +--- +name: Feature Request +about: Solidity language or infrastructure feature requests. +--- + +## Prerequisites + +- First, many thanks for taking part in the community. We really appreciate that. +- We realize there is a lot of data requested here. We ask only that you do your best to provide as much information as possible so we can better help you. +- Support questions are better asked in one of the following locations: + - [Solidity chat](https://gitter.im/ethereum/solidity) + - [Stack Overflow](https://ethereum.stackexchange.com/) +- Ensure the issue isn't already reported (check `feature` and `language design` labels). + +*Delete the above section and the instructions in the sections below before submitting* + +## Abstract + +Please describe by example what problem you see in the current Solidity language +and reason about it. + +## Motivation + +In this section you describe how you propose to address the problem you described earlier, +including by giving one or more exemplary source code snippets for demonstration. + +## Specification + +The technical specification should describe the syntax and semantics of any new feature. The +specification should be detailed enough to allow any developer to implement the functionality. + +## Backwards Compatibility + +All language changes that introduce backwards incompatibilities must include a section describing +these incompatibilities and their severity. + +Please describe how you propose to deal with these incompatibilities. diff --git a/.github/ISSUE_TEMPLATE/general.md b/.github/ISSUE_TEMPLATE/general.md new file mode 100644 index 000000000..2d277865f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general.md @@ -0,0 +1,19 @@ +--- +name: General Feedback +about: Any general feedback (neither feature request nor bug reports) +--- + +## Prerequisites + +- First, many thanks for taking part in the community. We really appreciate that. +- Read the [contributing guidelines](http://solidity.readthedocs.io/en/latest/contributing.html). +- Support questions are better asked in one of the following locations: + - [Solidity chat](https://gitter.im/ethereum/solidity) + - [Stack Overflow](https://ethereum.stackexchange.com/) +- Ensure the issue isn't already reported. + +*Delete the above section and the instructions in the sections below before submitting* + +## Description + +Please describe the purpose of your ticket. diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE.md