Remove studio PR template in favor of org template. Preserve some imp…

…ortant details from PR template into dev docs
learningequality · Nov 14, 2024 · 6bcab61 · 6bcab61
1 parent 8780a1d
commit 6bcab61
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 84 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
diff --git a/docs/_index.md b/docs/_index.md
@@ -7,6 +7,7 @@
 - [Local development tools](./dev_tools.md)
 - [Running tests](./running_tests.md)
 - [Adding or updating dependencies](./dependencies.md)
+- [Preparing a pull request](../pull_requests.md)
 
 ## Additional development tools
 

diff --git a/docs/pull_requests.md b/docs/pull_requests.md
@@ -0,0 +1,16 @@
+Preparing a pull request
+=============
+
+Before opening or approving a PR, consider:
+
+Security and privacy:
+- If there new ways this uses user data that needs to be factored into our [Privacy Policy](https://github.com/learningequality/studio/tree/master/contentcuration/contentcuration/templates/policies/text), it has been noted.
+
+
+Internationalization:
+- All user-facing strings are translated properly
+- The `notranslate` class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
+- All UI components are LTR and RTL compliant
+
+Deployment:
+- Migrations are [safe for a large db](https://www.braintreepayments.com/blog/safe-operations-for-high-volume-postgresql/)