-
Notifications
You must be signed in to change notification settings - Fork 103
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
Template : PR & Issue #231
Comments
Proposal for Pull Requests @niftools/blender-plugin-reviewer PR OverviewFixes Known IssuesFixes xyz DocumentationWhat was documented TestingManualManual steps AutomatedTests written to avoid regression in future Additional Information |
Proposal for Issue Template @niftools/blender-plugin-reviewer Blender Nif Plugin Version InfoIssue OverviewSteps to reproduceLogsBlend FileNif FileSimilar Known IssuesAdditional Information |
At least for issues, I feel that it's better to provide the issue-er with a description of what to do: [provide general introduction to the issue logging and why it is relevant to this repository] Context[provide more detailed introduction to the issue itself and why it is relevant] Steps to Reproduce[ordered list the process to finding and recreating the issue] Expected result[describe what you would expect to have resulted from this process] Current result[describe what you you currently experience from this process, and thereby explain the bug] Possible Fix[not obligatory, but suggest fixes or reasons for the bug] Screenshot[if relevant, include a screenshot] Logs and Files[provide links to logs file generated during the error as well as the blend and nif files you were using at the time] Additional Information[anything else you feel is relevant] |
I do like that each section has its own description of content. |
All templates merged |
Add templates to the repo so that we can have a standardise the way of working.
https://help.github.com/articles/creating-an-issue-template-for-your-repository/
https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/
The text was updated successfully, but these errors were encountered: