aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorchriseth <chris@ethereum.org>2018-09-20 20:34:20 +0800
committerchriseth <chris@ethereum.org>2018-09-27 23:09:39 +0800
commit9bb5737d56be438c6a719ba6def2a2abbfdf3eb8 (patch)
tree4abcb867246536619002ec386b489a24b3f25d6c
parentcb3a837251087001c738cb8f123db231bb00a31d (diff)
downloaddexon-solidity-9bb5737d56be438c6a719ba6def2a2abbfdf3eb8.tar.gz
dexon-solidity-9bb5737d56be438c6a719ba6def2a2abbfdf3eb8.tar.zst
dexon-solidity-9bb5737d56be438c6a719ba6def2a2abbfdf3eb8.zip
Put instructions in comments.
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md9
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md12
-rw-r--r--.github/ISSUE_TEMPLATE/general.md6
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md6
4 files changed, 25 insertions, 8 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 0cc0edec..c3caf86e 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -3,7 +3,7 @@ name: Bug Report
about: Bug reports about the Solidity Compiler.
---
-## Prerequisites
+<!--## Prerequisites
- First, many thanks for taking part in the community. We really appreciate that.
- We realize there is a lot of information requested here. We ask only that you do your best to provide as much information as possible so we can better help you.
@@ -12,12 +12,11 @@ about: Bug reports about the Solidity Compiler.
- [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.
+<!--Please shortly describe the bug you have found, and what you expect instead.-->
## Environment
@@ -28,6 +27,7 @@ Please shortly describe the bug you have found, and what you expect instead.
## 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.
@@ -36,3 +36,4 @@ Provide as much information as necessary to reproduce the bug.
// Some *minimal* Solidity source code to reproduce the bug.
// ...
```
+--> \ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 6b98fb99..6702b62c 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -3,7 +3,7 @@ name: Feature Request
about: Solidity language or infrastructure feature requests.
---
-## Prerequisites
+<!--## 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.
@@ -14,24 +14,34 @@ about: Solidity language or infrastructure feature requests.
*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.
+--> \ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/general.md b/.github/ISSUE_TEMPLATE/general.md
index 2d277865..410b42e0 100644
--- a/.github/ISSUE_TEMPLATE/general.md
+++ b/.github/ISSUE_TEMPLATE/general.md
@@ -3,7 +3,7 @@ name: General Feedback
about: Any general feedback (neither feature request nor bug reports)
---
-## Prerequisites
+<!--## 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).
@@ -13,7 +13,9 @@ about: Any general feedback (neither feature request nor bug reports)
- 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/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 6f544bc1..9734fe81 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,8 +1,9 @@
-### Your checklist for this pull request
+<!--### Your checklist for this pull request
Please review the [guidelines for contributing](http://solidity.readthedocs.io/en/latest/contributing.html) to this repository.
Please also note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
+-->
### Checklist
- [ ] Code compiles correctly
@@ -13,6 +14,9 @@ Please also note that this project is released with a [Contributor Code of Condu
- [ ] Used meaningful commit messages
### Description
+
+<!--
Please explain the changes you made here.
Thank you for your help!
+--> \ No newline at end of file