aboutsummaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorErik Kundt <bitshift@posteo.org>2018-07-27 19:32:46 +0800
committerChristian Parpart <christian@ethereum.org>2018-08-07 16:42:21 +0800
commit264985868ef5ac009d235b2eb5725b580d2a6cc8 (patch)
treebdd4b9696bb8d3c3b6bc44581991de1a51452a0c /.github/ISSUE_TEMPLATE
parent9d03de1f250cecad2c5c796beb10d96c3c9b15cd (diff)
downloaddexon-solidity-264985868ef5ac009d235b2eb5725b580d2a6cc8.tar
dexon-solidity-264985868ef5ac009d235b2eb5725b580d2a6cc8.tar.gz
dexon-solidity-264985868ef5ac009d235b2eb5725b580d2a6cc8.tar.bz2
dexon-solidity-264985868ef5ac009d235b2eb5725b580d2a6cc8.tar.lz
dexon-solidity-264985868ef5ac009d235b2eb5725b580d2a6cc8.tar.xz
dexon-solidity-264985868ef5ac009d235b2eb5725b580d2a6cc8.tar.zst
dexon-solidity-264985868ef5ac009d235b2eb5725b580d2a6cc8.zip
Adds issue templates for GitHub.
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md38
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md37
-rw-r--r--.github/ISSUE_TEMPLATE/general.md19
3 files changed, 94 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..196cbb32
--- /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 00000000..6b98fb99
--- /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 00000000..2d277865
--- /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.