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

Conversation

aeriforme
Copy link
Member

@aeriforme aeriforme commented Dec 21, 2024

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.

@aeriforme aeriforme requested review from EZoni and ax3l December 21, 2024 01:06
@aeriforme aeriforme added the component: documentation Docs, readme and manual label Dec 21, 2024
CONTRIBUTING.rst Outdated Show resolved Hide resolved
aeriforme and others added 5 commits January 14, 2025 09:48
Co-authored-by: Edoardo Zoni <[email protected]>
Co-authored-by: Edoardo Zoni <[email protected]>
Co-authored-by: Edoardo Zoni <[email protected]>
Co-authored-by: Edoardo Zoni <[email protected]>
@aeriforme aeriforme marked this pull request as ready for review January 14, 2025 18:11
@aeriforme aeriforme changed the title [WIP] Docs and issue templates: clarify usage of issues and discussions Docs and issue templates: clarify usage of issues and discussions Jan 14, 2025
@EZoni
Copy link
Member

EZoni commented Jan 14, 2025

@ax3l

What do you think of these changes? For context, the idea came up after realizing that the default blank issues (now unavailable) were being a bit overused/misused.

@ax3l ax3l self-assigned this Jan 22, 2025
Copy link
Member

@ax3l ax3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, very nice guidance!

Adding a few links just to make it easier.

CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@ax3l ax3l merged commit b9c31fd into ECP-WarpX:development Jan 24, 2025
29 of 36 checks passed
@ax3l
Copy link
Member

ax3l commented Jan 24, 2025

Ah sheesh, I just remembered you can add actual links (e.g., to discussions page) instead of using a template.

@aeriforme @EZoni check out how homebrew does this: https://github.com/Homebrew/homebrew-core/issues/new/choose

That way, we can still keep the blank issue option at the very end and add guidance when someone clicks new issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Docs, readme and manual
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants