Update CONTRIBUTING to match reality and add issue templates for bug reports, feature requests, and usage questions #1644
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
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.
Description
CONTRIBUTING.mdwas pretty out of date and didn't include any information aboutcargo testorcargo fix. There were also some grammar/wording issues that I fixed along the way.Additionally, I added a section for getting started with hacking on PHPWord, which may not be completely obvious to many people, especially those using GitHub, Composer, or PHPUnit for the first time.
In the process, I noticed the existing singular issue template was a bit confusing and was trying to do many things at once (bug report, feature request, and prevent usage questions). I replaced that with three issue templates using GitHub's new functionality, one for each of those use cases:
.github/ISSUE_TEMPLATE/bug_report.mdwill be labeled "Bug report: Create a report to help improve PHPWord", label the issue with "Bug Report", and ask users to describe the bug, code to reproduce, expected and current behavior, and context. I tried to match the wording of the current issue template for the relevant sections..github/ISSUE_TEMPLATE/feature_request.mdwill be labeled "Feature request: Suggest an idea for this project", label the issue "Change Request", and ask the users to describe the problem they're trying to address, the solution they'd like, alternatives they've thought of, and additional context (I've mostly matched GitHub's default for this).github/ISSUE_TEMPLATE/how-to-use.mdwill be labeled "How to Use PHPWord: Find out how to use PHPWord", label any issues created with "WontFix", and tell the user not to use the issue tracker to ask how to use PHPWord, along with links to documentation, sample code, and Stack Overflow to ask questions.I also moved the pull request template to
/.github/to avoid confusion for anyone looking to edit the templates (better to have everything in one spot).I tried to stay true to the current wording/format/etc, but may have strayed in some areas. Feel free to update as necessary, or I'll be around if you need me to make any changes.
Fixes # (issue)
Checklist:
composer run-script check --timeout=0and no errors were reported