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

Template : PR & Issue #231

Closed
3 tasks done
neomonkeus opened this issue Mar 10, 2016 · 6 comments
Closed
3 tasks done

Template : PR & Issue #231

neomonkeus opened this issue Mar 10, 2016 · 6 comments
Assignees
Labels
Documentation Issue incorporates changes/improvements to the documentation Improvement The issue improves on existing functionality

Comments

@neomonkeus
Copy link
Member

Add templates to the repo so that we can have a standardise the way of working.

  • Pull Requests
  • Issues
  • Contributing

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/

@neomonkeus neomonkeus added Improvement The issue improves on existing functionality Documentation Issue incorporates changes/improvements to the documentation Restructure Internal code changes that improve developers sanity labels Mar 10, 2016
@neomonkeus
Copy link
Member Author

Proposal for Pull Requests

@niftools/blender-plugin-reviewer

PR Overview

Fixes Known Issues

Fixes xyz

Documentation

What was documented

Testing

Manual

Manual steps

Automated

Tests written to avoid regression in future

Additional Information

@neomonkeus neomonkeus added this to the v2.6.0a0.dev4 milestone Mar 22, 2016
@neomonkeus neomonkeus self-assigned this Mar 22, 2016
@neomonkeus
Copy link
Member Author

Proposal for Issue Template

@niftools/blender-plugin-reviewer

Blender Nif Plugin Version Info

Issue Overview

Steps to reproduce

Logs

Blend File

Nif File

Similar Known Issues

Additional Information

@GandaG
Copy link

GandaG commented Mar 23, 2016

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]

@neomonkeus neomonkeus removed the Restructure Internal code changes that improve developers sanity label Mar 23, 2016
@neomonkeus
Copy link
Member Author

I do like that each section has its own description of content.
If there is no objections, I will use this as the initial draft implementation and open a pull request. Any additions from this discussion issue can added to the implementation.

@neomonkeus
Copy link
Member Author

Opened #239 & #240

@neomonkeus
Copy link
Member Author

All templates merged

@neomonkeus neomonkeus added this to To do in Plugin System via automation May 31, 2018
@neomonkeus neomonkeus moved this from To do to Done in Plugin System May 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issue incorporates changes/improvements to the documentation Improvement The issue improves on existing functionality
Projects
Plugin System
  
Released
Development

No branches or pull requests

2 participants