docs: Add note in repo_checks README about tagging maintainers in PRs

openedx · Jul 8, 2024 · ed4c01a · ed4c01a
1 parent 9a3c2ac
commit ed4c01a
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/edx_repo_tools/repo_checks/README.rst b/edx_repo_tools/repo_checks/README.rst
@@ -47,7 +47,9 @@ Finally, when you're ready, you can actually apply the fixes to GitHub::
 
   repo_checks --no-dry-run <... same args you used above ...>
 
-Contributing
+Note this will open pull requests in the relevant repos. Some repos intentionally don't have certain workflows (for example, ``docs.openedx.org`` does not use ``commitlint``), so please tag maintainers on the pull requests so they can decide whether or not to use the added or changed workflows.
+
+  Contributing
 ************
 
 * Make changes on your branch.