Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Github templates. #848

Merged
merged 5 commits into from
Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 25 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,31 @@ assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.
Please give a clear and concise description of the bug. For us to be able to
fix the bug we need to be able to reproduce it. As a result, if you provide a
reproducer, i.e. code that exhibits the bug (incl. build instructions) but is
stripped of all unessential complexity, the chance of getting the issue fixed
is much higher.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Version Information**
- HighFive:
- Compiler:
- [optional] OS:
- [optional] CMake:
- [optional] HDF5:

**Expected behavior**
A clear and concise description of what you expected to happen.
**Style Guide**
1. Please paste text as text and not as a screen shot.
2. If in doubt paste too much output rather than to little, i.e. don't be too
1uc marked this conversation as resolved.
Show resolved Hide resolved
scared of a large wall of text. Especially, if it's a compiler error.
(Anything past the first error is largely uninformative and can be safely
stripped.)
3. Please strip all boilerplate.

**Stacktrace**
If applicable, add a stacktrace and error messages to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. ubuntu 20.10, macos 10.15]
- Version [e.g. master branch]

**Additional context**
Add any other context about the problem here.
Markdown summary:
````
Some include `code` and a block:
```
void foo();
```
````
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/build_failure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Build failure
about: Report an issue with the build-system.
title: ''
labels: ''
assignees: ''

---

**Bug Description**
Unfortunately, build failures tend to be highly specific and there's many
things that could go wrong on both our and your side. Therefore, a reproducer
is essential. You could try the minimal setup found here:
https://github.com/BlueBrain/HighFive/blob/master/doc/installation.md#manually-install-highfive

from there you can work upwards by adding complexity until you reproduce the
issue.

Once you have a reproducer, please paste it and the exact `cmake` command used to
configure the build and include the output. For the compilation phase please
ensure that the actual compiler invocation is visible, e.g.,
```
$ cmake --build build --verbose
[ 50%] Building CXX object CMakeFiles/dummy.dir/dummy.cpp.o
/usr/bin/c++ ... -isystem ${HIGHFIVE_ROOT}/include -isystem ${HDF5_ROOT}/include ... -c dummy.cpp
```
and include at least the first error message. (If in doubt include more rather
than less output.)

**Version Information**
- HighFive:
- Compiler:
- OS:
- CMake:
- HDF5:

**Style Guide**
1. Please paste text as text and not as a screen shot.
2. If in doubt paste too much output rather than too little, i.e. don't be too
scared of a large wall of text. Especially, if it's a compiler error.
(Anything past the first error is largely uninformative and can be safely
stripped.)
3. Please strip all boilerplate.

Markdown summary:
````
Some inline `code` and a block:
```
void foo();
```

Links can simply be pasted:
https://github.com/BlueBrain/HighFive
````
11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,3 @@ assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context about the feature request here.
25 changes: 0 additions & 25 deletions .github/pull_request_template.md

This file was deleted.