From 1460b112f653378a9ce16d5ea851ca088db8760b Mon Sep 17 00:00:00 2001 From: Joel Ostblom Date: Sat, 23 Mar 2024 15:36:54 -0700 Subject: [PATCH] Improve message --- .github/PULL_REQUEST_TEMPLATE.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a5828c4d1..16020fa47 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,9 @@ - - + - Here is a [helpful article about writing effective PR descriptions](https://medium.com/@greenberg/writing-pull-requests-your-coworkers-might-enjoy-reading-9d0307e93da3. +- Include unit tests and documentation for new feautres) +- Ensure that the title is a concise [semantic commit message](https://www.conventionalcommits.org/) (e.g. "feat: Add `embed_options` to charts"). + - Append `!` if the change is breaking (e.g. "fix!: Error when `embed_options` is `None`")