chore: update contribution guidelines

rome · Dec 6, 2022 · d04eb92 · d04eb92
1 parent 5cd4dfd
commit d04eb92
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
@@ -17,3 +17,10 @@
 ## Test Plan
 
 <!-- Demonstrate the code is solid. Example: The exact commands you ran and their output. -->
+
+## Documentation
+
+<!-- Tick the checkboxes if your PR requires some documentation, and if you will follow up with that -->
+
+- [ ] The PR requires documentation
+- [ ] I will create a new PR to update the documentation
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -175,6 +175,14 @@ test(lint): add more cases to handle invalid rules
 
 When creating a new pull request, it's preferable to use a conventional commit-formatted title, as this title will be used as the default commit message on the squashed commit after merging.
 
+Please use the template provided.
+
+If you PR requires some update on the website (new features, breaking changes, etc.), a new follow-up
+PR should be created against the "release" PR. If you can't create a new PR, please let the team know,
+the template should help to give all the information to the team.
+
+The team will prepare a new PR after each new release, just search for "release" among the opened pull requests.
+
 Here are some other scripts that you might find useful.
 
 #### If you are a core contributor