docs: treat all work as PUBLIC aws#6125

avi-alpert · Dec 4, 2024 · 4af7533 · 4af7533
1 parent 963723b
commit 4af7533
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,6 +6,7 @@
 
 ---
 
-<!--- REMINDER: Ensure that your PR meets the guidelines in CONTRIBUTING.md -->
+- Treat all work as PUBLIC. Private `feature/x` branches will not be squash-merged at release time.
+- Your code changes must meet the guidelines in [CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines).
 
 License: I confirm that my contribution is made under the terms of the Apache 2.0 license.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -238,9 +238,12 @@ You can find documentation to create VSCode IDE settings for CodeCatalyst bluepr
 
 Before sending a pull request:
 
+1. Treat all work as PUBLIC. Private `feature/x` branches will _not_ be squash-merged at release time. This has several benefits:
+    - Avoids mistakes (accidental exposure to public)!
+    - Avoids needing to erase (squash-merge) history.
 1. Check that you are working against the latest source on the `master` branch.
-2. Check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. Open an issue to discuss any significant work.
+1. Check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+1. Open an issue to discuss any significant work.
 
 To send a pull request: