From e4a29085f30b8d2747f980d9d4ffe1f89f82231c Mon Sep 17 00:00:00 2001
From: Claire Kuang <kuang.claire@gmail.com>
Date: Wed, 29 Jan 2025 12:56:17 +0000
Subject: [PATCH] chore(template): amends pr template to be more descriptive
 (#535)

* Update pull_request_template.md

* Update pull_request_template.md
---
 .github/pull_request_template.md | 67 ++++++++++++++------------------
 1 file changed, 29 insertions(+), 38 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 1efeba6a8..49d7d2d32 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,30 +1,46 @@
 <!---
 
-Provide a short summary in the Title above. Examples of good PR titles:
+Provide a short summary in the Title above. Use the following template:
 
-* "Feature: adds metrics to component"
+category(project): summary
 
-* "Fix: resolves duplication in comment thread"
+Categories:
 
-* "Update: apollo v2.34.0"
+* 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 & motivation
+## Description
 
 <!---
 
-Describe your changes, and why you're making them.  What benefit will this have to others?
+Describe your changes, and why you're making them.
 
-Is this linked to an open Github issue, a thread in Speckle community,
-or another pull request? Link it here.
-
-If it is related to a Github issue, and resolves it, please link to the issue number, e.g.:
-Fixes #85, Fixes #22, Fixes username/repo#123
-Connects #123
+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:
 
 <!---
@@ -68,35 +84,10 @@ Describe what tests have been added or amended, and why these demonstrate it wor
 
 <!---
 
-This checklist is mostly useful as a reminder of small things that can easily be
-
-forgotten – it is meant as a helpful tool rather than hoops to jump through.
-
-Put an `x` between the square brackets, e.g. [x], for all the items that apply,
-
-make notes next to any that haven't been addressed, and remove any items that are not relevant to this PR.
+This checklist is a useful reminder of related tasks to uphold our repo quality. Amend this list as needed for the pr.
 
 -->
-
-- [ ] My pull request follows the guidelines in the [Contributing guide](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)?
-- [ ] My pull request does not duplicate any other open [Pull Requests](../../pulls) for the same update/change?
 - [ ] My commits are related to the pull request and do not amend unrelated code or documentation.
-- [ ] My code follows a similar style to existing code.
 - [ ] I have added appropriate tests.
 - [ ] I have updated or added relevant documentation.
 
-## References
-
-<!---
-
-(Optional -- remove this section if not needed )
-
-Include **important** links regarding the implementation of this PR.
-
-This usually includes a RFC or an aggregation of issues and/or individual conversations
-
-that helped put this solution together. This helps ensure we retain and share knowledge
-
-regarding the implementation, and may help others understand motivation and design decisions etc..
-
--->