Skip to content

Commit

Permalink
Create Issue Templates
Browse files Browse the repository at this point in the history
Create issue templates for:
- bugs
- installation issues
- feature requests
- blank
  • Loading branch information
ax3l committed Sep 17, 2024
1 parent 12bf069 commit 2209d15
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us reproduce your problem.
title: ''
labels: [bug]
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Please share your WarpX inputs files or PICMI Python files here.
You can drag-and-drop files into this form or zip up larger collections of files, e.g., including analysis scripts to reproduce your problem.

Please minimize your inputs/scripts to be concise and focused on your issue.
For instance, make the simulation scripts very small and fast to run, whenever possible.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Software Environment**
- version of WarpX: [YY.MM]
- installed WarpX via: [conda-forge, spack, pip, brew, from source, module system, ...]
- operating system: [name and version]
- machine: [Are you running on a public cluster? It's likely we compute on it as well!]
- name and version of Python implementation: [e.g. CPython 3.12]

**Additional context**
Add any other context about the problem here.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: [enhancement]
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 or screenshots about the feature request here.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/installation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Installation Issue
about: Trouble installing WarpX? Let us help you.
title: ''
labels: [install, question]
assignees: ''

---

**Where are you trying to install and run WarpX?**
A clear and concise description of where you like to run.

**Software Environment**
- version of WarpX: [e.g., latest or 24.09]
- operating system: [name and version]
- machine: [Are you running on a public cluster? It's likely we compute on it as well!]

**What have you tried so far?**
- installing WarpX via: [conda-forge, spack, pip, brew, from source, module system, ...]

**Installation from Source**
Are you installing form source? If so, please provide:
- the output of `cmake --fresh -S . -B build`
- the output of `cmake --build build`

Let us also know more about your software environment in that case:
- version of CMake: [e.g. 3.24.0]
- name and version of your C++ compiler: [e.g., GNU 11.3 with NVCC 12.0.76]
- name and version of Python implementation: [e.g. CPython 3.12]
- version of ADIOS2: [e.g. 2.10.0]
- version of FFTW: [e.g. 3.3.10]
- version of HDF5: [e.g. 1.14.0]
- name and version of MPI: [e.g. OpenMPI 4.1.1]
- name of other relevant dependency names and version: [e.g. NumPy 2.0, Ascent 0.8.0, etc.]

**Screenshots**
If applicable, add screenshots to help explain your problem.

0 comments on commit 2209d15

Please sign in to comment.