e4a29085f3
* Update pull_request_template.md * Update pull_request_template.md
94 lines
1.9 KiB
Markdown
94 lines
1.9 KiB
Markdown
<!---
|
|
|
|
Provide a short summary in the Title above. Use the following template:
|
|
|
|
category(project): summary
|
|
|
|
Categories:
|
|
|
|
* feat: (new feature for the user, not a new feature for build script)
|
|
* fix: (bug fix for the user, not a fix to a build script)
|
|
* docs: (changes to the documentation)
|
|
* style: (formatting, missing semi colons, etc; no production code change)
|
|
* refactor: (refactoring production code, eg. renaming a variable)
|
|
* test: (adding missing tests, refactoring tests; no production code change)
|
|
* chore: (updating grunt tasks etc; no production code change)
|
|
|
|
Example:
|
|
|
|
feat(revit): added category filter to send
|
|
|
|
-->
|
|
|
|
## Description
|
|
|
|
<!---
|
|
|
|
Describe your changes, and why you're making them.
|
|
|
|
Link related github issues here ->
|
|
Fixes #85, Fixes #22, Connects #123
|
|
|
|
-->
|
|
|
|
## User Value
|
|
|
|
<!---
|
|
|
|
Describe in 1 sentence the user value.
|
|
|
|
This can also be a link to the relevant thread in Speckle community, or a link to the Linear issue.
|
|
-->
|
|
|
|
|
|
## Changes:
|
|
|
|
<!---
|
|
|
|
- Item 1
|
|
- Item 2
|
|
|
|
-->
|
|
|
|
## To-do before merge:
|
|
|
|
<!---
|
|
|
|
(Optional -- remove this section if not needed)
|
|
|
|
Include any notes about things that need to happen before this PR is merged, e.g.:
|
|
|
|
- [ ] Change the base branch
|
|
|
|
- [ ] Ensure PR #56 is merged
|
|
|
|
-->
|
|
|
|
## Screenshots:
|
|
|
|
<!---
|
|
|
|
Include a screenshot the before and after. This can be a screenshot of a plugin, web frontend, or output in a terminal.
|
|
|
|
-->
|
|
|
|
## Validation of changes:
|
|
|
|
<!---
|
|
|
|
Describe what tests have been added or amended, and why these demonstrate it works and will prevent this feature being accidentally broken by future changes.
|
|
|
|
-->
|
|
|
|
## Checklist:
|
|
|
|
<!---
|
|
|
|
This checklist is a useful reminder of related tasks to uphold our repo quality. Amend this list as needed for the pr.
|
|
|
|
-->
|
|
- [ ] My commits are related to the pull request and do not amend unrelated code or documentation.
|
|
- [ ] I have added appropriate tests.
|
|
- [ ] I have updated or added relevant documentation.
|
|
|