Skip to content

Commit 98fe07a

Browse files
zbeekmanzbeekman
committed
Merge branch 'template-doc-updates' of github.com:sourceryinstitute/OpenCoarrays
2 parents 257ed2e + 2a8cdd5 commit 98fe07a

12 files changed

+158
-98
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 3 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,5 @@
1-
<!-- Please fill out the issue template included below, failure to do -->
2-
<!-- so may result in immediate closure of your issue. -->
1+
Please fill out one of the templates at: https://github.com/sourceryinstitute/OpenCoarrays/issues/new/choose
32

4-
<!-- Fill out all portions of this template that apply. Please delete -->
5-
<!-- any unnecessary sections. -->
3+
Failure to fill out a template will result in the issue being closed without comment.
64

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-
13-
| Avg response time |
14-
|:------------------------------:|
15-
| ![Issue Stats][issue stat img] |
16-
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.
26-
27-
<!-- THE FOLLOWING INFORMATION IS MANDATORY if you would like our help -->
28-
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 -->
37-
38-
## Observed Behavior ##
39-
40-
## Expected Behavior ##
41-
42-
## Steps to Reproduce ##
43-
44-
# Question #
45-
46-
<!-- delete this section if it does not apply -->
47-
The title of the issue should start with `Question:` followed by a
48-
succinct title. Add the text of your question here. Be specific. Search for
49-
answers on [Google] and [Stack Overflow]
50-
before asking a new question
51-
52-
# Request for Enhancement (RFE) #
53-
54-
<!-- delete this section if it does not apply -->
55-
The title of the issue should start with `RFE:` followed by a succinct
56-
title. Add a description of your requested enhancement here. If you are
57-
willing to help out please also read the [Helping Out] section of
58-
[CONTRIBUTING.md]
59-
60-
[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/
64-
[GFortran bug tracker]: https://gcc.gnu.org/bugzilla/
65-
[Intel MPI]: https://software.intel.com/en-us/intel-mpi-library
66-
[MPT]: http://www.sgi.com/products/software/sps.html
67-
[MVAPICH]: http://mvapich.cse.ohio-state.edu
68-
[MPICH]: https://www.mpich.org
69-
[Open-MPI]: https://www.open-mpi.org
70-
[CONTRIBUTING.md]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md
71-
[Helping Out]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md#helping-out
72-
[official release]: https://github.com/sourceryinstitute/OpenCoarrays/releases
73-
[CMake install]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/INSTALL.md#cmake-scripts
74-
[homebrew]: https://brew.sh
75-
[issues page]: https://github.com/sourceryinstitute/OpenCoarrays/issues
76-
[mailing list]: https://groups.google.com/forum/#!forum/opencoarrays
77-
[install.sh]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/install.sh
5+
Thanks!

‎.github/ISSUE_TEMPLATE/questions-and-support-requests.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Questions and Support Requests
3+
about: Issue template to use for general questions and support request that are not
4+
bugs or feature requests.
5+
6+
---
7+
8+
**Please note we will close your issue without comment if you delete, do not read or do not fill out the issue checklist below and provide ALL the requested information.**
9+
10+
The title of the issue should start with `Question:` followed by a
11+
succinct title.
12+
13+
<!-- PRO TIP! You can submit the issue first, then use the gui/web interface to check the -->
14+
<!-- checkboxes! -->
15+
16+
- [ ] I am not reporting a bug or asking for a new feature
17+
- [ ] I am asking a general question about, e.g., the internal workings of this software, the direct use of this software, or use cases for this software, etc.
18+
- [ ] I have already searched for the answer to my question on [Google] and [Stack Overflow]
19+
20+
Please be descriptive, precise and concise. Thanks!
21+
22+
[Google]: https://www.google.com
23+
[Stack Overflow]: https://stackoverflow.com

‎.github/ISSUE_TEMPLATE/reproducible-bug-report.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Reproducible Bug Report
3+
about: File a bug report so we can fix it
4+
5+
---
6+
7+
The title of the issue should start with `Defect:` followed by a
8+
succinct title.
9+
10+
Please make sure to put any logs, terminal output, or code in
11+
[fenced code blocks]. Please also read the [contributing guidelines][CONTRIBUTING.md]
12+
before submitting a new issue.
13+
14+
**Please note we will close your issue without comment if you delete, do not read or do not fill out the issue checklist below and provide ALL the requested information.**
15+
16+
- [ ] I am reporting a bug others will be able to reproduce and not asking a question or requesting a new feature.
17+
18+
## System information including:
19+
- OpenCoarrays Version: <!-- `caf --version` or `./install.sh --version` -->
20+
- Fortran Compiler: <!-- vendor & version number-->
21+
- C compiler used for building lib: <!-- vendor & version -->
22+
- Installation method: <!-- `install.sh`, or package manager etc. -->
23+
- All flags & options passed to the installer
24+
- Output of `uname -a`:
25+
- MPI library being used: <!-- e.g., MPICH 3.2 -->
26+
- Machine architecture and number of physical cores:
27+
- Version of CMake: <!-- if preinstalled & installing yourself -->
28+
29+
## To help us debug your issue please explain:
30+
31+
### What you were trying to do (and why)
32+
33+
34+
### What happened (include command output, screenshots, logs, etc.)
35+
36+
37+
### What you expected to happen
38+
39+
40+
### Step-by-step reproduction instructions to reproduce the error/bug
41+
42+
43+
44+
[links]:#
45+
[fenced codeblocks]: https://help.github.com/articles/creating-and-highlighting-code-blocks/
46+
[CONTRIBUTING.md]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md

‎.github/ISSUE_TEMPLATE/request-for-enhancement.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Request for Enhancement
3+
about: Request a new feature or new functionality in this project
4+
5+
---
6+
7+
The title of the issue should start with `RFE:` followed by a succinct
8+
title. If you are
9+
willing to help out please also read the [Helping Out] section of
10+
[CONTRIBUTING.md]
11+
12+
Please replace this section with:
13+
14+
- a detailed description of your proposed feature
15+
- the motivation for the feature, i.e., why would this software be better if your feature were added?
16+
- how the feature would be relevant to users (if it's not: do not open a feature request)
17+
- what alternatives to the feature you have considered
18+
19+
[CONTRIBUTING.md]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md
20+
[Helping Out]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md#helping-out

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!-- Please fill out the pull request template included below, failure -->
2-
<!-- to do so may result in immediate closure of your pull request. -->
1+
<!-- Please fill out the pull request template included below. Failure -->
2+
<!-- to do so may result in immediate closure of your pull request! -->
33

44
<!-- Fill out all portions of this template that apply. Please delete -->
55
<!-- any unnecessary sections. -->
@@ -11,12 +11,11 @@
1111
[links]:#
1212
[contributing guidelines]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md
1313
[issue]: https://github.com/sourceryinstitute/OpenCoarrays/issues
14-
[PR response img]: https://img.shields.io/issuestats/p/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square
1514
[coverage]: https://img.shields.io/codecov/c/github/sourceryinstitute/OpenCoarrays/master.svg?style=flat-square
1615

17-
| Avg response time | coverage on master |
18-
|:---------------------------------:|:---------------------------:|
19-
| ![Issue Stats][PR response img] | ![Codecov branch][coverage] |
16+
| coverage on master |
17+
|:---------------------------:|
18+
| ![Codecov branch][coverage] |
2019

2120
## Summary of changes ##
2221

@@ -36,18 +35,27 @@ This pull request (PR) is a:
3635

3736
### I certify that ###
3837

39-
- [ ] I reviewed and followed the [contributing guidelines], including
40-
- Increasing test coverage for all feature-addition PRs
41-
- Increasing test coverage for all bug-fix PRs for which there
42-
does not already exist a related test that failed before the PR
43-
- At least maintaining test coverage for all other PRs
44-
- Ensuring that all tests pass when run locally
45-
- Naming PR to indicate work in progress (WIP) and to attach the PR
46-
to the appropriate bug report or feature request [issue]
47-
- White space (no trailing white space or white space errors may
48-
be introduced)
49-
- Commenting code where it is non-obvious and non-trivial
50-
- Logically atomic, self consistent and coherent commits
51-
- Commit message content
52-
- Waiting 24 hours before self-approving the PR to give another
38+
- [ ] I have reviewed and followed the [contributing guidelines]
39+
- [ ] I will wait at least 24 hours before self-approving the PR to give another
5340
OpenCoarrays developer a chance to review my proposed code
41+
- [ ] I have not introduced errant white space (no trailing white space or white space errors may
42+
be introduced)
43+
- [ ] I have added an explanation of what these changes do and why they should be included
44+
- [ ] I have checked to ensure there aren't other open [Pull Requests] for the same change
45+
- [ ] I have you written new tests for these changes
46+
- [ ] I have successfully tested these changes locally
47+
- [ ] I have commented any non-trivial, non-obvious code changes
48+
- [ ] The commits are logically atomic, self consistent and coherent
49+
- [ ] The [commit messages] follow [best practices]
50+
- [ ] Test coverage is maintained or increased after this is merged
51+
52+
53+
## Code coverage data
54+
55+
![coverage on master](https://codecov.io/gh/sourceryinstitute/OpenCoarrays/branch/master/graphs/commits.svg)
56+
57+
58+
[links]: #
59+
[best practices]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
60+
[commit messages]: https://thoughtbot.com/blog/5-useful-tips-for-a-better-commit-message
61+
[Pull Requests]: https://github.com/sourceryinstitue/OpenCoarrays/pulls

‎.github/no-response.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Configuration for probot-no-response - https://github.com/probot/no-response
2+
3+
# Number of days of inactivity before an Issue is closed for lack of response
4+
daysUntilClose: 21
5+
# Label requiring a response
6+
responseRequiredLabel: needs response
7+
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
8+
closeComment: >
9+
This issue has been automatically closed because there has been no response
10+
to our request for more information from the original author. With only the
11+
information that is currently in the issue, we don't have enough information
12+
to take action. Please reach out if you have or find the answers we need so
13+
that we can investigate further.

‎.github/stale.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
daysUntilStale: 28
5+
# Number of days of inactivity before a stale Issue or Pull Request is closed
6+
daysUntilClose: 21
7+
# Issues or Pull Requests with these labels will never be considered stale
8+
exemptLabels:
9+
- help wanted
10+
- in progress
11+
# Label to use when marking as stale
12+
staleLabel: stale
13+
# Comment to post when marking as stale. Set to `false` to disable
14+
markComment: >
15+
This issue has been automatically marked as stale because it has not had
16+
recent activity. It will be closed if no further activity occurs.

‎.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "wiki"]
2+
path = wiki
3+
url = ../OpenCoarrays.wiki.git

‎Brewfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414
brew 'cmake'
1515
brew 'gcc'
16-
brew 'mpich', args: ['cc=gcc-7', 'build-from-source']
17-
brew 'opencoarrays', args: ['cc=gcc-7', 'build-from-source']
16+
brew 'mpich', args: ['cc=gcc-8', 'build-from-source']
17+
brew 'opencoarrays', args: ['cc=gcc-8', 'build-from-source']
1818

1919
# [Homebrew]: http://brew.sh
2020
# [Linuxbrew]: http://linuxbrew.sh

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ to aid in development efforts.
190190
[Jupyter]: https://jupyter.org
191191
[index.ipynb]: https://nbviewer.jupyter.org/github/sourceryinstitute/jupyter-CAF-kernel/blob/master/index.ipynb
192192

193-
[build img]: https://img.shields.io/travis-ci/sourceryinstitute/OpenCoarrays/master.svg?style=flat-square "Travis-CI build badge"
193+
[build img]: https://img.shields.io/travis/sourceryinstitute/OpenCoarrays.svg?style=flat-square "Build badge"
194194
[CI Master Branch]: https://travis-ci.org/sourceryinstitute/OpenCoarrays?branch=master "View Travis-CI builds"
195195
[download img]: https://img.shields.io/github/downloads/sourceryinstitute/OpenCoarrays/total.svg?style=flat-square "Download count badge"
196196
[license img]: https://img.shields.io/badge/license-BSD--3-blue.svg?style=flat-square "BSD-3 License badge"

0 commit comments

Comments
 (0)