Skip to content

Commit 05a6759

Browse files
committed
Add github issue template
Blank stub for PR template Update CONTRIBUTING.md [ci skip]
1 parent 9520b41 commit 05a6759

File tree

4 files changed

+146
-1
lines changed

4 files changed

+146
-1
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ prerequisites/build text
3131
developer-scripts export-ignore
3232
codecov.yml export-ignore
3333
*.enc export-ignore
34+
.github

.github/ISSUE_TEMPLATE.md

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
<!-- Please fill out the issue template included below, failure to do -->
2+
<!-- so may result in immediate closure of your issue. -->
3+
4+
<!-- Fill out all portions of this template that apply. Please delete -->
5+
<!-- any unnecessary sections. -->
6+
7+
- [ ] I have surrounded any code, or log output in codeblock fences
8+
(` ``` `) if it occupies more than one line, or in single
9+
backticks if it is short `short code`
10+
11+
<!-- Long code goes in a fenced code block: -->
12+
<!-- ``` -->
13+
<!-- Line one of code output -->
14+
<!-- Line two of output -->
15+
<!-- etc. -->
16+
<!-- ``` -->
17+
18+
19+
# Question: #
20+
21+
<!-- delete this section if it does not apply -->
22+
The title of the issue should start with `Question:` followed by a
23+
succinct title. Add the text of your question here. Be specific. Search for
24+
answers on https://google.com and https://stackoverflow.com
25+
before asking a new question
26+
27+
# RFE: #
28+
29+
<!-- delete this section if it does not apply -->
30+
The title of the issue should start with `RFE:` followed by a succinct
31+
title. Add a description of your requested enhancement here. If you are
32+
willing to help out please also read the [Helping Out] section of
33+
[CONTRIBUTING.md]
34+
35+
36+
37+
# Defect/bug report #
38+
39+
<!-- delete this section if it does not apply -->
40+
The title of the issue should start with `Defect:` followed by a
41+
succinct title.
42+
43+
Please replace `[ ]` with `[X]` to indicate you have taken the requested action
44+
45+
- [ ] I have searched the [issues page] and [mailing list] and did
46+
not find any issue matching the one I would like to report
47+
- [ ] I have included a succinct description of the problem,
48+
including the steps necessary to reproduce it
49+
- [ ] I have included which version of OpenCoarrays I am working
50+
with, or the output of `git describe` if working with a cloned
51+
repository rather than an [official release]
52+
- [ ] I have included the MPI library name and version I am using
53+
with OpenCoarrays
54+
- [ ] name: [MPICH] version:
55+
- [ ] name: [Open-MPI] version:
56+
- [ ] name: [MVAPICH] version:
57+
- [ ] name: [MPT] version:
58+
- [ ] name: [Intel MPI] version:
59+
- [ ] other:
60+
<!-- delete all but the matching MPI implementation -->
61+
- [ ] I have included the Fortran compiler name and version that I am
62+
using with OpenCoarrays
63+
- [ ] I have included the output of `uname -a`
64+
- [ ] I have included the Operating system name and version,
65+
including linux distro
66+
- [ ] I have included the machine name if I am allowed to do so and
67+
wish to seek help debugging on that particular system (Titan,
68+
Pleiades, Excalibur, Lightening, Mira, etc.)
69+
70+
## Installation/build problem ##
71+
72+
<!-- delete this section if it does not apply -->
73+
74+
- [ ] I have attached a log of the attempted build/installation,
75+
changing the extension to `.txt` and uploaded it to this issue
76+
- [ ] I have indicated if previous versions of OpenCoarrays are or
77+
were installed on the machine in question
78+
<!-- please select one from the top level-->
79+
- [ ] Build/install was attempted with [install.sh]
80+
- [ ] I have attached the `install-opencoarrays.log` file
81+
after re-running the script with the debug flags `-d` and
82+
`-v` turned on (after renaming the log file to have a `.txt`
83+
extension)
84+
- [ ] Build/install was attempted with system package manager like
85+
[homebrew] (which one?)
86+
- [ ] Build/install was attempted with manual/advanced
87+
[CMake install]
88+
- [ ] Name and version of the C compiler being used
89+
- [ ] Name and version of the Fortran compiler being used
90+
- [ ] Attached/included the output of the configure step with
91+
CMake. (Usually something like `cd build && cmake ..`)
92+
- [ ] Attached/included the output of `make VERBOSE=1`
93+
- [ ] Attached/included the output of `ctest --verbose`
94+
- [ ] Other build/install was attempted (please describe)
95+
96+
Don't forget the description of the problem. The more details you give
97+
us, the faster, and more easily we can help you
98+
99+
## Compile time or run time error
100+
101+
<!-- delete this section if it does not apply -->
102+
103+
<!-- pick one of the first two -->
104+
- [ ] I am experiencing a compile time error (all gfortran ICEs
105+
should be reported to the [GFortran bug tracker]... You can post
106+
the ICE here too for tracking purposes, with a link to the
107+
GFortran problem report)
108+
- [ ] I am experiencing a runtime issue
109+
- [ ] I have included a minimally complete verifiable example (MCVE)
110+
that exhibits the problem and suitable for adding to regression
111+
tests (option, but you receive infinite karma
112+
for including this)
113+
114+
Description with as many details as possible to reproduce the problem.
115+
116+
117+
[links]:#
118+
[GFortran bug tracker]: https://gcc.gnu.org/bugzilla/
119+
[Intel MPI]: https://software.intel.com/en-us/intel-mpi-library
120+
[MPT]: http://www.sgi.com/products/software/sps.html
121+
[MVAPICH]: http://mvapich.cse.ohio-state.edu
122+
[MPICH]: https://www.mpich.org
123+
[Open-MPI]: https://www.open-mpi.org
124+
[CONTRIBUTING.md]: https://github.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.md
125+
[Helping Out]: https://github.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.md#helping-out
126+
[official release]: https://github.com/sourceryinstitute/opencoarrays/releases
127+
[CMake install]: https://github.com/sourceryinstitute/opencoarrays/blob/master/INSTALL.md#cmake-scripts
128+
[homebrew]: http://brew.sh
129+
[issues page]: https://github.com/sourceryinstitute/opencoarrays/issues
130+
[mailing list]: https://groups.google.com/forum/#!forum/opencoarrays
131+
[install.sh]: https://github.com/sourceryinstitute/opencoarrays/blob/master/install.sh

.github/PULL_REQUEST_TEMPLATE.md

Whitespace-only changes.

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,12 @@ If you encounter problems during the course of [Installing] OpenCoarrays or [usi
3333
- Number of MPI ranks/processing elements/coarray images being run on
3434
- How the code was compiled, including all flags and commands
3535
- Minimal reproducer code (a few lines) required to trigger the bug
36-
4. Any help you can provide diagnosing, isolating and fixing the problem is appreciated! Please see the [helping out] section for more information.
36+
4. Any help you can provide diagnosing, isolating and fixing the
37+
problem is appreciated! Please see the [helping out] section for
38+
more information.
39+
40+
An [issue template] is in the `.github` folder to help ensure
41+
compliance, and adequate information is provided.
3742

3843
Requesting Enhancements
3944
-----------------------
@@ -86,6 +91,14 @@ The `master` branch should remain in pristine, stable condition all of the time.
8691

8792
This is the development branch, akin to GCC's `trunk`. Both of `devel` and `master` branches are protected, but `devel` will eventually be merged into `master` when the next major release happens, but until then it is a stable, forward looking branch where experimental features and major changes or enhancements may be applied and tested. Just as with `master` all changes are applied atomically as pull requests.
8893

94+
---
95+
96+
[![GitHub forks](https://img.shields.io/github/forks/sourceryinstitute/opencoarrays.svg?style=social&label=Fork)](https://github.com/sourceryinstitute/opencoarrays/fork)
97+
[![GitHub stars](https://img.shields.io/github/stars/sourceryinstitute/opencoarrays.svg?style=social&label=Star)](https://github.com/sourceryinstitute/opencoarrays)
98+
[![GitHub watchers](https://img.shields.io/github/watchers/sourceryinstitute/opencoarrays.svg?style=social&label=Watch)](https://github.com/sourceryinstitute/opencoarrays)
99+
[![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?hashtags=HPC,Fortran,PGAS&related=zbeekman,gnutools,HPCwire,HPC_Guru,hpcprogrammer,SciNetHPC,DegenerateConic,jeffdotscience,travisci&text=Stop%20programming%20w%2F%20the%20%23MPI%20docs%20in%20your%20lap%2C%20try%20Coarray%20Fortran%20w%2F%20OpenCoarrays%20%26%20GFortran!&url=https%3A//github.com/sourceryinstitute/opencoarrays)
100+
101+
89102
[Links]: #
90103
[video]: https://youtu.be/EwWZbyjDs9c?list=PLg7s6cbtAD17uAwaZwiykDci_q3te3CTY
91104
[a number of resources]: http://scottchacon.com/2011/08/31/github-flow.html

0 commit comments

Comments
 (0)