[4.x] Update contribution guide (#9133)

* Note about opening a docs issue for new features or behavior changes * Add pull request template * Tweaks --------- Co-authored-by: Jack McDade <[email protected]>
statamic · Dec 9, 2023 · fe936cb · fe936cb
1 parent de7ec29
commit fe936cb
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+First of all, thank _you_ 🫵 for taking the time to contribute to Statamic, we really appreciate it! 💜
+
+Please take 30 seconds to read the following so we can be as efficient as possible when reviewing and considering merging PRs:
+
+1️⃣ Is this your first PR? If so, please read our [contribution guide](https://statamic.dev/contribution-guide) first.
+
+2️⃣ Please make sure to create a new branch for your PR.
+
+3️⃣ Typically you should target the branch of the most current release, e.g. `4.x`, unless your PR includes a breaking change, in which case you should target the `master` branch for the next major release.
+
+4️⃣ We _really_ appreciate it if your PR includes tests. This makes it much easier for us to review, merge, and release. A PR with tests is usually reviewed and merged 5x-10x faster.
+
+5️⃣ If your PR introduce a new feature, adds to an existing one, or changes current behavior, please **open an issue for it in the [statamic/docs](https://github.com/statamic/docs/issues) repo referencing your PR**. A simple "Goes along with statamic/cms#9000" is enough. Otherwise it's really easy to forget and no will ever become aware of your ✨ sparkling ✨ invention if it's not documented.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -83,6 +83,8 @@ We welcome new translations and updates! Please follow [these instructions](http
 
 Pull requests should clearly describe the problem and solution. Include the relevant issue number if there is one. If the pull request fixes a bug, it should include a new test case that demonstrates the issue, if possible.
 
+Creating a pull request that introduces a new feature or changes current behavior? Please open an issue referencing your PR in the [statamic/docs](https://github.com/statamic/docs/issues) repo. No need to write the docs yourself. We'll take care of that for you. Any hints or bullet points are appreciated though!
+
 PR titles should include the major version number they're targeted at — e.g. [4.x] or [3.x].
 
 <br>
-Original file line number
+Diff line change
@@ Expand Up @@
     Pull requests should clearly describe the problem and solution. Include the relevant issue number if there is one. If the pull request fixes a bug, it should include a new test case that demonstrates the issue, if possible.
+    Creating a pull request that introduces a new feature or changes current behavior? Please open an issue referencing your PR in the [statamic/docs](https://github.com/statamic/docs/issues) repo. No need to write the docs yourself. We'll take care of that for you. Any hints or bullet points are appreciated though!
     PR titles should include the major version number they're targeted at — e.g. [4.x] or [3.x].
     <br>
@@ Expand Down @@