Skip to content

Commit 9bb5737

Browse files
committed
Put instructions in comments.
1 parent cb3a837 commit 9bb5737

4 files changed

Lines changed: 25 additions & 8 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Bug Report
33
about: Bug reports about the Solidity Compiler.
44
---
55

6-
## Prerequisites
6+
<!--## Prerequisites
77
88
- First, many thanks for taking part in the community. We really appreciate that.
99
- 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.
1212
- [Stack Overflow](https://ethereum.stackexchange.com/)
1313
- Ensure the issue isn't already reported.
1414
- 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.
15-
16-
*Delete the above section and the instructions in the sections below before submitting*
15+
-->
1716

1817
## Description
1918

20-
Please shortly describe the bug you have found, and what you expect instead.
19+
<!--Please shortly describe the bug you have found, and what you expect instead.-->
2120

2221
## Environment
2322

@@ -28,6 +27,7 @@ Please shortly describe the bug you have found, and what you expect instead.
2827

2928
## Steps to Reproduce
3029

30+
<!--
3131
Please provide a *minimal* source code example to trigger the bug you have found.
3232
Please also mention any command line flags that are necessary for triggering the bug.
3333
Provide as much information as necessary to reproduce the bug.
@@ -36,3 +36,4 @@ Provide as much information as necessary to reproduce the bug.
3636
// Some *minimal* Solidity source code to reproduce the bug.
3737
// ...
3838
```
39+
-->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Feature Request
33
about: Solidity language or infrastructure feature requests.
44
---
55

6-
## Prerequisites
6+
<!--## Prerequisites
77
88
- First, many thanks for taking part in the community. We really appreciate that.
99
- 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.
1414
1515
*Delete the above section and the instructions in the sections below before submitting*
1616
17+
-->
18+
1719
## Abstract
1820

21+
<!--
1922
Please describe by example what problem you see in the current Solidity language
2023
and reason about it.
24+
-->
2125

2226
## Motivation
2327

28+
<!--
2429
In this section you describe how you propose to address the problem you described earlier,
2530
including by giving one or more exemplary source code snippets for demonstration.
31+
-->
2632

2733
## Specification
2834

35+
<!--
2936
The technical specification should describe the syntax and semantics of any new feature. The
3037
specification should be detailed enough to allow any developer to implement the functionality.
38+
-->
3139

3240
## Backwards Compatibility
3341

42+
<!--
3443
All language changes that introduce backwards incompatibilities must include a section describing
3544
these incompatibilities and their severity.
3645
3746
Please describe how you propose to deal with these incompatibilities.
47+
-->

.github/ISSUE_TEMPLATE/general.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: General Feedback
33
about: Any general feedback (neither feature request nor bug reports)
44
---
55

6-
## Prerequisites
6+
<!--## Prerequisites
77
88
- First, many thanks for taking part in the community. We really appreciate that.
99
- 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)
1313
- Ensure the issue isn't already reported.
1414
1515
*Delete the above section and the instructions in the sections below before submitting*
16-
16+
-->
1717
## Description
1818

19+
<!--
1920
Please describe the purpose of your ticket.
21+
-->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
### Your checklist for this pull request
1+
<!--### Your checklist for this pull request
22
33
Please review the [guidelines for contributing](http://solidity.readthedocs.io/en/latest/contributing.html) to this repository.
44
55
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.
6+
-->
67

78
### Checklist
89
- [ ] Code compiles correctly
@@ -13,6 +14,9 @@ Please also note that this project is released with a [Contributor Code of Condu
1314
- [ ] Used meaningful commit messages
1415

1516
### Description
17+
18+
<!--
1619
Please explain the changes you made here.
1720
1821
Thank you for your help!
22+
-->

0 commit comments

Comments
 (0)