-
Notifications
You must be signed in to change notification settings - Fork 230
Create Issue Templates #5278
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
Merged
+135
−0
Merged
Create Issue Templates #5278
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
2209d15
Create Issue Templates
ax3l 1fbee7f
Work on templates (bug report, installation issue)
EZoni 994d0fa
More work on templates
EZoni 0870ea7
Apply suggestions from code review
EZoni a75e8bf
Update bug_report.md
EZoni 0de5a29
Update feature_request.md
EZoni 1d01947
Update bug_report.md
EZoni a2476e3
Update installation-issue.md
EZoni c2ddc96
Update feature_request.md
EZoni 0a6179a
Update installation-issue.md
EZoni 752c010
Update feature_request.md
EZoni 2adfe0b
Update bug_report.md
EZoni 70b7a9a
Update installation-issue.md
EZoni 11c4b33
Update installation-issue.md
EZoni 779b3b6
Update bug_report.md
EZoni a6c81e7
Update feature_request.md
EZoni 73b3137
Update bug_report.md
EZoni 619d8c8
Update feature_request.md
EZoni 08d1d20
Update installation-issue.md
EZoni 1875c6b
Merge `ECP-WarpX:development` into `ax3l:topic-issue-templates`
EZoni cbe78fc
Update installation-issue.md
EZoni File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Report a bug or unexpected behavior. | ||
| labels: [bug] | ||
| --- | ||
|
|
||
| _Please remove any sensitive information (e.g., passwords, API keys) from your submission. | ||
| Please check the relevant boxes and fill in the specific versions or details for the relevant items. | ||
| Thank you for taking the time to report this issue. We will respond as soon as possible._ | ||
|
|
||
| ## Description | ||
| A clear and concise description of the bug. | ||
|
|
||
| ## Expected behavior | ||
| What did you expect to happen when you encountered the issue? | ||
|
|
||
| ## How to reproduce | ||
| Please provide (if available): | ||
| - WarpX inputs files | ||
| - PICMI Python files | ||
| - Python post-processing scripts | ||
|
|
||
| If you are unable to provide certain files or scripts, please describe the steps you took to encounter the issue. | ||
|
|
||
| Please minimize your inputs/scripts to be concise and focused on the issue. | ||
| For instance, make the simulation scripts as small and fast to run as possible. | ||
|
|
||
| ## System information | ||
| Please check all relevant boxes and provide details. | ||
|
|
||
| - Operating system (name and version): | ||
| - [ ] Linux: e.g., Ubuntu 22.04 LTS | ||
| - [ ] macOS: e.g., macOS Monterey 12.4 | ||
| - [ ] Windows: e.g., Windows 11 Pro | ||
| - Version of WarpX: e.g., latest, 24.10, etc. | ||
| - Installation method: | ||
| - [ ] Conda | ||
| - [ ] Spack | ||
| - [ ] PyPI | ||
| - [ ] Brew | ||
| - [ ] From source with CMake | ||
| - [ ] Module system on an HPC cluster | ||
| - Other dependencies: yes/no, describe | ||
| - Computational resources: | ||
| - [ ] MPI: e.g., 2 MPI processes | ||
| - [ ] OpenMP: e.g., 2 OpenMP threads | ||
| - [ ] CPU: e.g., 2 CPUs | ||
| - [ ] GPU: e.g., 2 GPUs (NVIDIA, AMD, etc.) | ||
|
|
||
| If you encountered the issue on an HPC cluster, please check our [HPC documentation](https://warpx.readthedocs.io/en/latest/install/hpc.html) to see if your HPC cluster is already supported. | ||
|
|
||
| ## Steps taken so far | ||
| What troubleshooting steps have you taken so far, and what were the results? | ||
|
|
||
EZoni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Have you tried compiling and running in debug mode, following the instructions in our [debugging documentation](https://warpx.readthedocs.io/en/latest/usage/workflows/debugging.html)? | ||
|
|
||
| ## Additional information | ||
| If applicable, please add any additional information that may help explain the issue, such as log files (e.g., build logs, error logs, etc.), error messages (e.g., compiler errors, runtime errors, etc.), screenshots, or other relevant details. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest a new feature or enhancement. | ||
| labels: [enhancement] | ||
| --- | ||
|
|
||
EZoni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| _Please remove any sensitive information (e.g., passwords, API keys) from your submission. | ||
| Please check the relevant boxes and fill in the specific versions or details for the relevant items. | ||
| Thank you for taking the time to report this issue. We will respond as soon as possible._ | ||
|
|
||
| ## Context and motivation | ||
| Please provide a clear and concise description of the context that is prompting you to request a new feature. What problem are you trying to solve, and how will this feature help you achieve your goals? | ||
|
|
||
| ## Proposed feature | ||
| Describe the feature you would like to add to WarpX in detail. Please include: | ||
| - A clear and concise description of the feature | ||
| - Any relevant technical requirements or specifications | ||
| - How you envision the feature being used | ||
|
|
||
| ## Alternative solutions | ||
| Have you considered any alternative solutions or features that could achieve the same goal? If so, please describe them and explain why you believe the proposed feature is the best solution. | ||
|
|
||
| ## Additional information | ||
| If applicable, please provide any additional information that may be relevant to the feature request, such as: | ||
| - Links to existing codes or implementations | ||
| - References to relevant publications or research | ||
| - Any specific use cases or scenarios where the feature would be particularly useful | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| name: Installation issue | ||
| about: Report an issue with installing or setting up WarpX | ||
| labels: [install] | ||
| --- | ||
|
|
||
EZoni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| _Please remove any sensitive information (e.g., passwords, API keys) from your submission. | ||
| Please check the relevant boxes and fill in the specific versions or details for the relevant items. | ||
| Thank you for taking the time to report this issue. We will respond as soon as possible._ | ||
|
|
||
| ## Description | ||
| A clear and concise description of the issue. | ||
|
|
||
| ## System information | ||
| - Operating system (name and version): | ||
| - [ ] Linux: e.g., Ubuntu 22.04 LTS | ||
| - [ ] macOS: e.g., macOS Monterey 12.4 | ||
| - [ ] Windows: e.g., Windows 11 Pro | ||
| - Version of WarpX: e.g., latest, 24.10, etc. | ||
| - Installation method: | ||
| - [ ] Conda | ||
| - [ ] Spack | ||
| - [ ] PyPI | ||
| - [ ] Brew | ||
| - [ ] From source with CMake | ||
| - [ ] Module system on an HPC cluster | ||
| - Other dependencies: yes/no, describe | ||
| - Computational resources: | ||
| - [ ] CPU | ||
| - [ ] GPU: e.g., NVIDIA, AMD, etc. | ||
|
|
||
| If you encountered the issue on an HPC cluster, please check our [HPC documentation](https://warpx.readthedocs.io/en/latest/install/hpc.html) to see if your HPC cluster is already supported. | ||
|
|
||
| If you encountered the issue installing from source with CMake, please provide the output of the following steps: | ||
| 1. buildsystem generation: output of `cmake --fresh -S . -B build` (include your specific build options, e.g., `-DWarpX_DIMS=3`) | ||
| 2. project build: output of `cmake --build build` (include your specific build options, e.g., `-j 4`) | ||
|
|
||
| If applicable, please add any additional information about your software environment: | ||
| - [ ] CMake: e.g., 3.24.0 | ||
| - [ ] C++ compiler: e.g., GNU 11.3 with NVCC 12.0.76 | ||
| - [ ] Python: e.g., CPython 3.12 | ||
| - [ ] MPI: e.g., OpenMPI 4.1.1 | ||
| - [ ] FFTW: e.g., 3.3.10 | ||
| - [ ] HDF5: e.g., 1.14.0 | ||
| - [ ] ADIOS2: e.g., 2.10.0 | ||
| - Other dependencies: yes/no, describe | ||
|
|
||
| ## Additional information | ||
| If applicable, please add any additional information that may help explain the issue, such as log files (e.g., build logs, error logs, etc.), error messages (e.g., compiler errors, runtime errors, etc.), screenshots, or other relevant details. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.