Improve clarity around bug/feature requests, and reorder sections #1475
Conversation
This file contains 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
Improved text under reporting bugs, to focus on what to do to raise an issue, and clarify the point about new packages just being an example of a new feature request. I am also proposing reordering the sections to group the key end-user focused sections (report bugs, chat, discussions, mailing lists) before the developer-oriented ones.
tormath1
reviewed
Jun 21, 2024
Co-authored-by: Mathieu Tortuyaux <[email protected]>
tormath1
approved these changes
Jun 21, 2024
ader1990
approved these changes
Jun 28, 2024
|
Merging PR as it's been approved a while ago. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Improved text under reporting bugs, to focus on what to do to raise an issue, and clarify the point about new packages just being an example of a new feature request. I am also proposing reordering the sections to group the key end-user focused sections (report bugs, chat, discussions, mailing lists) before the developer-oriented ones.
improved readme for key end-user sections (raising bugs, getting in touch with the team)
How to use
Read the md
Testing done
Read it in the github browser.