Skip to content

Commit b9c31fd

Browse files
aeriformeEZoniax3l
authored
Docs and issue templates: clarify usage of issues and discussions (#5527)
This PR adds guidance and best practices on how to use issues and discussions. This is useful to avoid issues that should be discussions, for example. --------- Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com> Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
1 parent 1b2afd8 commit b9c31fd

File tree

3 files changed

+45
-1
lines changed

3 files changed

+45
-1
lines changed

.github/ISSUE_TEMPLATE/blank_issue.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Blank issue
3+
about: Ask us a question
4+
labels: [question]
5+
---
6+
7+
Are you here because you have something to report that is neither a bug, a new feature, nor an installation problem?
8+
9+
Before opening this issue, consider opening a [discussion](https://github.com/ECP-WarpX/WarpX/discussions) instead!
10+
11+
Issues are used to report bugs, installation problems or to request new features.
12+
Discussions are used to ask more open-ended questions, brainstorm, ask our feedback, etc.
13+
14+
You can find more details on how to use issues and discussions [here](https://github.com/ECP-WarpX/WarpX/blob/development/CONTRIBUTING.rst).

.github/ISSUE_TEMPLATE/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
blank_issues_enabled: true
1+
blank_issues_enabled: false

CONTRIBUTING.rst

+30
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,36 @@ Git workflow
1212
The WarpX project uses `git <https://git-scm.com>`_ for version control.
1313
If you are new to git, you can follow `this tutorial <https://swcarpentry.github.io/git-novice/>`__.
1414

15+
16+
What to do when
17+
^^^^^^^^^^^^^^^
18+
19+
Issues
20+
""""""
21+
22+
`Issues <https://github.com/ECP-WarpX/WarpX/issues>`__ are used to track tasks that the contributors and/or maintainers can work on.
23+
Use issues for reporting bugs or installation problems and for requesting new features.
24+
25+
If you've found a bug and wish to report it, first search the open issues and `pull requests <https://github.com/ECP-WarpX/WarpX/pulls>`__ to see if someone else has already reported the same thing.
26+
If it's something new, open an issue using a template.
27+
We'll use the issue to address the problem you've encountered.
28+
29+
Discussions
30+
"""""""""""
31+
32+
`Discussions <https://github.com/ECP-WarpX/WarpX/discussions>`__ are for open-ended conversations, general questions, brainstorming ideas.
33+
Please, use discussions if you want to ask us something that is not technically a bug or a feature.
34+
Feel free to ping us there!
35+
36+
Pull Requests (PRs)
37+
"""""""""""""""""""
38+
39+
Open a `pull request <https://github.com/ECP-WarpX/WarpX/pulls>`__ if you want to add a new feature yourself.
40+
Follow the guide below for more details.
41+
42+
43+
Thank you for contributing! 🥰
44+
1545
Configure your GitHub Account & Development Machine
1646
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1747

0 commit comments

Comments
 (0)