Improve message

vega · Mar 23, 2024 · 1460b11 · 1460b11
1 parent 0ccdba6
commit 1460b11
Showing 1 changed file with 5 additions and 8 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,12 +1,9 @@
-
-<!--
 Thanks for contributing to Altair!
 
-Read the guidelines below and then delete this comment before submitting your PR.
+Read the PR guidelines below and then delete this message before submitting your PR.
 
 - Describe the purpose of the changes in PR, so that it is easy to understand the implication of the suggested changes.
-    - 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 are None")
--->
+    - 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`")