Add pull request template (#37)
* Add pull request template * Yeet Bevy reference * Increase allowed markdown line length to 160 * Fix structure of markdown lint config file Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Delta semántico
Ninguna definición cambió: el cambio es de texto, documentación o datos.
2 archivos · +29 −10
diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml
index 8bdfc20fc..da6285182 100644
--- a/.github/linters/.markdown-lint.yml
+++ b/.github/linters/.markdown-lint.yml
@@ -18,16 +18,8 @@
###############
# Rules by id #
###############
-# MD004: false # Unordered list style
-# MD007:
-# indent: 2 # Unordered list indentation
-# MD013:
-# line_length: 400 # Line length 80 is far to short
-# MD026:
-# punctuation: ".,;:!。,;:" # List of not allowed
-# MD029: false # Ordered list item prefix
-# MD033: false # Allow inline HTML
-# MD036: false # Emphasis used instead of a heading
+MD013:
+ line_length: 160
#################
# Rules by tags #
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..c4c2af325
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,27 @@
+# Objective
+
+- Describe the objective or issue this PR addresses.
+- If you're fixing a specific issue, say "Fixes #X".
+
+## Solution
+
+- Describe the solution used to achieve the objective above.
+
+---
+
+## Changelog
+
+> This section is optional. If this was a trivial fix, or has no externally-visible impact, you can delete this section.
+
+- What changed as a result of this PR?
+- If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings
+- Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section
+ - If you can't summarize the work, your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge!
+
+## Migration Guide
+
+> This section is optional. If there are no breaking changes, you can delete this section.
+
+- If this PR is a breaking change (relative to the last release of this crate), describe how a user might need to migrate their code to support these changes
+- Simply adding new functionality is not a breaking change.
+- Fixing behavior that was definitely a bug, rather than a questionable design choice is not a breaking change.