docs: add pull request template & update contributing docs.

Signed-off-by: qicz <qiczzhu@gmail.com>
envoyproxy · Apr 17, 2023 · 765ef28 · 765ef28
1 parent 6baaaf1
commit 765ef28
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,19 @@
+**What type of PR is this?**
+<!--
+Your PR title should be descriptive, and generally start with type that contains a subsystem name with `()` if necessary 
+and summary followed by a colon. format `chore/docs/feat/fix/refactor/style/test: summary`.
+Examples:
+* "docs: fix grammar error"
+* "feat(translator): add new feature"
+* "fix: fix xx bug"
+* "chore: change ci & build tools etc"
+-->
+
+**What this PR does / why we need it**:
+
+**Which issue(s) this PR fixes**:
+<!--
+*Automatically closes linked issue when PR is merged.
+Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
+-->
+Fixes #
diff --git a/docs/latest/dev/CONTRIBUTING.md b/docs/latest/dev/CONTRIBUTING.md
@@ -49,10 +49,13 @@ to the following guidelines for all code, APIs, and documentation:
 * All code comments and documentation are expected to have proper English grammar and punctuation.
   If you are not a fluent English speaker (or a bad writer ;-)) please let us know and we will try
   to find some help but there are no guarantees.
-* Your PR title should be descriptive, and generally start with a subsystem name followed by a
-  colon. Examples:
+* Your PR title should be descriptive, and generally start with type that contains a subsystem name with `()` if necessary 
+  and summary followed by a colon. format `chore/docs/feat/fix/refactor/style/test: summary`.
+  Examples:
   * "docs: fix grammar error"
-  * "translator: add new feature"
+  * "feat(translator): add new feature"
+  * "fix: fix xx bug"
+  * "chore: change ci & build tools etc"
 * Your PR commit message will be used as the commit message when your PR is merged. You should
   update this field if your PR diverges during review.
 * Your PR description should have details on what the PR does. If it fixes an existing issue it

diff --git a/docs/latest/dev/README.md b/docs/latest/dev/README.md
@@ -6,7 +6,7 @@ Envoy Gateway is built using a [make][]-based build system. Our CI is based on [
 
 ### go
 
-* Version: 1.19
+* Version: 1.20
 * Installation Guide: https://go.dev/doc/install
 
 ### make