Skip to content

Commit 1f5ce0d

Browse files
committed
Cleanup Issues template
1 parent ee8d657 commit 1f5ce0d

File tree

1 file changed

+37
-98
lines changed

1 file changed

+37
-98
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 37 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -4,123 +4,63 @@
44
<!-- Fill out all portions of this template that apply. Please delete -->
55
<!-- any unnecessary sections. -->
66

7+
<!-- PRO TIP! Submit the pull request *before* you check any -->
8+
<!-- checkboxes. Then, use the gui/web interface to check the -->
9+
<!-- checkboxes! -->
10+
11+
[issue stat img]: https://img.shields.io/issuestats/i/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square
12+
713
| Avg response time |
8-
| ------------------------------ |
14+
|:------------------------------:|
915
| ![Issue Stats][issue stat img] |
1016

11-
Please replace `[ ]` with `[X]` to indicate you have taken the requested action
17+
Please make sure to put any logs, terminal output, or code in
18+
[fenced code blocks]. Please also read the [contributing guidelines]
19+
before submitting a new issue.
20+
21+
# Defect/Bug Report #
22+
23+
<!-- delete this section if it does not apply -->
24+
The title of the issue should start with `Defect:` followed by a
25+
succinct title.
1226

13-
- [ ] I have surrounded any code, or log output in codeblock fences
14-
(` ``` `) if it occupies more than one line, or in single
15-
backticks if it is short `short code`
27+
<!-- THE FOLLOWING INFORMATION IS MANDATORY if you would like our help -->
1628

17-
<!-- Long code goes in a fenced code block: -->
18-
<!-- ``` -->
19-
<!-- Line one of code output -->
20-
<!-- Line two of output -->
21-
<!-- etc. -->
22-
<!-- ``` -->
29+
- OpenCoarrays Version: <!-- `caf --version` or `./install.sh --version` -->
30+
- Fortran Compiler: <!-- vendor & version number-->
31+
- C compiler used for building lib: <!-- vendor & version -->
32+
- Installation method: <!-- `install.sh`, or package manager etc. -->
33+
- Output of `uname -a`:
34+
- MPI library being used: <!-- e.g., MPICH 3.2 -->
35+
- Machine architecture and number of physical cores:
36+
- Version of CMake: <!-- if preinstalled & installing yourself -->
2337

38+
## Observed Behavior ##
2439

25-
# Question: #
40+
## Expected Behavior ##
41+
42+
## Steps to Reproduce ##
43+
44+
# Question #
2645

2746
<!-- delete this section if it does not apply -->
2847
The title of the issue should start with `Question:` followed by a
2948
succinct title. Add the text of your question here. Be specific. Search for
30-
answers on https://google.com and https://stackoverflow.com
49+
answers on [Google] and [Stack Overflow]
3150
before asking a new question
3251

33-
# RFE: #
52+
# Request for Enhancement (RFE) #
3453

3554
<!-- delete this section if it does not apply -->
3655
The title of the issue should start with `RFE:` followed by a succinct
3756
title. Add a description of your requested enhancement here. If you are
3857
willing to help out please also read the [Helping Out] section of
3958
[CONTRIBUTING.md]
4059

41-
42-
43-
# Defect/bug report #
44-
45-
<!-- delete this section if it does not apply -->
46-
The title of the issue should start with `Defect:` followed by a
47-
succinct title.
48-
49-
- [ ] I have searched the [issues page] and [mailing list] and did
50-
not find any issue matching the one I would like to report
51-
- [ ] I have included a succinct description of the problem,
52-
including the steps necessary to reproduce it
53-
- [ ] I have included which version of OpenCoarrays I am working
54-
with, or the output of `git describe` if working with a cloned
55-
repository rather than an [official release]
56-
- [ ] I have included the MPI library name and version I am using
57-
with OpenCoarrays
58-
- [ ] name: [MPICH] version:
59-
- [ ] name: [Open-MPI] version:
60-
- [ ] name: [MVAPICH] version:
61-
- [ ] name: [MPT] version:
62-
- [ ] name: [Intel MPI] version:
63-
- [ ] other:
64-
<!-- delete all but the matching MPI implementation -->
65-
- [ ] I have included the Fortran compiler name and version that I am
66-
using with OpenCoarrays
67-
- [ ] I have included the output of `uname -a`
68-
- [ ] I have included the Operating system name and version,
69-
including linux distro
70-
- [ ] I have included the machine name if I am allowed to do so and
71-
wish to seek help debugging on that particular system (Titan,
72-
Pleiades, Excalibur, Lightening, Mira, etc.)
73-
74-
## Installation/build problem ##
75-
76-
<!-- delete this section if it does not apply -->
77-
78-
- [ ] I have attached a log of the attempted build/installation,
79-
changing the extension to `.txt` and uploaded it to this issue
80-
- [ ] I have indicated if previous versions of OpenCoarrays are or
81-
were installed on the machine in question
82-
83-
**Please select one from the following top level items** (please be sure to fill out all sub-items)**:**
84-
- [ ] Build/install was attempted with [install.sh]
85-
- [ ] I have attached the `install-opencoarrays.log` file
86-
after re-running the script with the debug flags `-d` and
87-
`-v` turned on (after renaming the log file to have a `.txt`
88-
extension)
89-
- [ ] Build/install was attempted with system package manager like
90-
[homebrew] (which one?)
91-
- [ ] Build/install was attempted with manual/advanced
92-
[CMake install]
93-
- [ ] Name and version of the C compiler being used
94-
- [ ] Name and version of the Fortran compiler being used
95-
- [ ] Attached/included the output of the configure step with
96-
CMake. (Usually something like `cd build && cmake ..`)
97-
- [ ] Attached/included the output of `make VERBOSE=1`
98-
- [ ] Attached/included the output of `ctest --verbose`
99-
- [ ] Other build/install was attempted (please describe)
100-
101-
Don't forget the description of the problem. The more details you give
102-
us, the faster, and more easily we can help you
103-
104-
## Compile time or run time error
105-
106-
<!-- delete this section if it does not apply -->
107-
108-
**Please choose one of the first two items**
109-
- [ ] I am experiencing a compile time error (all gfortran ICEs
110-
should be reported to the [GFortran bug tracker]... You can post
111-
the ICE here too for tracking purposes, with a link to the
112-
GFortran problem report)
113-
- [ ] I am experiencing a runtime issue
114-
115-
**:sparkles: Optional, but you will receive infinite karma for including this: :sparkles:**
116-
- [ ] I have included a minimally complete verifiable example (MCVE)
117-
that exhibits the problem and suitable for adding to regression
118-
tests
119-
120-
Don't forget a description with as many details as possible to reproduce the problem.
121-
122-
12360
[links]:#
61+
[Google]: https://www.google.com
62+
[Stack Overflow]: https://stackoverflow.com
63+
[fenced codeblocks]: https://help.github.com/articles/creating-and-highlighting-code-blocks/
12464
[GFortran bug tracker]: https://gcc.gnu.org/bugzilla/
12565
[Intel MPI]: https://software.intel.com/en-us/intel-mpi-library
12666
[MPT]: http://www.sgi.com/products/software/sps.html
@@ -131,8 +71,7 @@ Don't forget a description with as many details as possible to reproduce the pro
13171
[Helping Out]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md#helping-out
13272
[official release]: https://github.com/sourceryinstitute/OpenCoarrays/releases
13373
[CMake install]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/INSTALL.md#cmake-scripts
134-
[homebrew]: http://brew.sh
74+
[homebrew]: https://brew.sh
13575
[issues page]: https://github.com/sourceryinstitute/OpenCoarrays/issues
13676
[mailing list]: https://groups.google.com/forum/#!forum/opencoarrays
13777
[install.sh]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/install.sh
138-
[issue stat img]:https://img.shields.io/issuestats/i/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square

0 commit comments

Comments
 (0)