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

Docs and issue templates: clarify usage of issues and discussions #5527

Merged
merged 9 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from 3 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
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/blank_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Blank issue
about: Ask us a question
labels: [question]
---

Are you here because you have something to report that is neither a bug, a new feature, nor an installation problem?

Before opening this issue, consider opening a discussion instead!
aeriforme marked this conversation as resolved.
Show resolved Hide resolved

Issues are used to report bugs, installation problems or to request new features.
Discussions are used to ask more open-ended questions, brainstorm, ask our feedback, etc.

You can find more details on how to use issues and discussions [here](https://github.com/ECP-WarpX/WarpX/blob/development/CONTRIBUTING.rst).
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
blank_issues_enabled: true
blank_issues_enabled: false
27 changes: 27 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,33 @@ Git workflow
The WarpX project uses `git <https://git-scm.com>`_ for version control.
If you are new to git, you can follow `this tutorial <https://swcarpentry.github.io/git-novice/>`__.


What to do when
---------------
aeriforme marked this conversation as resolved.
Show resolved Hide resolved

Issues
aeriforme marked this conversation as resolved.
Show resolved Hide resolved

Issues are used to track tasks that the contributors and/or maintainers can work on.
Use issues for reporting bugs or installation problems and for requesting new features.

If you've found a bug and wish to report it, first search the open issues and pull requests to see if someone else has already reported the same thing.
ax3l marked this conversation as resolved.
Show resolved Hide resolved
If it's something new, open an issue using a template.
We'll use the issue to address the problem you've encountered.

Discussions
aeriforme marked this conversation as resolved.
Show resolved Hide resolved

Discussions are for open-ended conversations, general questions, brainstorming ideas.
ax3l marked this conversation as resolved.
Show resolved Hide resolved
Please, use discussions if you want to ask us something that is not technically a bug or a feature.
Feel free to ping us there!

Pull Requests (PRs)
aeriforme marked this conversation as resolved.
Show resolved Hide resolved

Open a pull request if you want to add a new feature yourself.
ax3l marked this conversation as resolved.
Show resolved Hide resolved
Follow the guide below for more details.


Thank you for contributing! 🥰

Configure your GitHub Account & Development Machine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down