Refactor: Simplify bug report guidance in CONTRIBUTING.md
Per your feedback, this commit refactors the section on writing bug reports in CONTRIBUTING.md.
The guidance now provides only an example of a good bug report. The previous link and mention of a "bad one" or an article discussing bad examples have been removed to simplify the section.
#45
Conversation
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
This commit introduces a CONTRIBUTING.md file to provide guidelines for contributors. It outlines how to report bugs, suggest features, and submit pull requests. The file also references the existing CODE_OF_CONDUCT.md and clarifies that contributions are made under the MIT License. Additionally, a "Contributing" section has been added to README.md with a direct link to the new CONTRIBUTING.md file for better visibility.
The link for the "bad" bug report example in CONTRIBUTING.md previously pointed to the same Stack Overflow question as the "good" example. This commit updates the link to point to Simon Tatham's article "How to Report Bugs Effectively" (https://www.chiark.greenend.org.uk/~sgtatham/bugs.html). This article provides comprehensive guidance on writing effective bug reports and understanding common pitfalls, making it a more valuable resource than a single example of a bad report. The accompanying text has also been reworded to accurately reflect that the new link directs to an article with guidance, rather than a specific bad bug report example.
The link for the "bad" bug report example in CONTRIBUTING.md previously pointed to the same Stack Overflow question as the "good" example. I updated the link for the "bad one" to point to Simon Tatham's article "How to Report Bugs Effectively" (https://www.chiark.greenend.org.uk/~sgtatham/bugs.html). This article provides comprehensive guidance on writing effective bug reports and understanding common pitfalls. The accompanying text remains as it was, ensuring only the link was updated as per your feedback.
Per your feedback, this commit refactors the section on writing bug reports in `CONTRIBUTING.md`. The guidance now provides only an example of a good bug report. The previous link and mention of a "bad one" or an article discussing bad examples have been removed to simplify the section.
|
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.
No description provided.