From 35edd3d93b9cc85298294e632cab0a1292aa5446 Mon Sep 17 00:00:00 2001
From: David Weisiger <dweisiger@gmail.com>
Date: Tue, 13 Dec 2022 20:30:27 -0500
Subject: [PATCH] refactor

---
 CONTRIBUTING.md | 11 +++++++++++
 README.md       |  8 ++++----
 2 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 18a5d228822..1e69b90e697 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,6 +5,7 @@
 1. [Issue guide](#issue-guide)
 2. [Coding style guide](#coding-style-guide)
 3. [Documentation style guide](#documentation-style-guide)
+4. [Git workflow](#git-workflow)
 
 ## Issue guide
 
@@ -113,6 +114,16 @@ Group documentation under one of the four categories:
   && echo "looks good when copy pastad"
   ```
 
+## Git workflow
+
+### Submitting a PR
+
+Please make sure to use a conventional commit in your PR title (eg. `feat(scope): description of feature`). This will be squashed and merged into the `main` branch.
+
+### GitHub Actions
+
+Each commit will automatically trigger the GitHub Actions to run. If any commit message in your push or the HEAD commit of your PR contains the strings [skip ci], [ci skip], [no ci], [skip actions], or [actions skip] workflows triggered on the push or pull_request events will be skipped.
+
 ## References
 
 - [Diátaxis](https://diataxis.fr/)
diff --git a/README.md b/README.md
index 69563d0868c..c1ac5e3a4ad 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,10 @@
 
 </div>
 
+## Documentation
+
+Most documentation can be found on the website, at [taiko.xyz](https://taiko.xyz). There should also be a README in each package, as well as comments in the source code.
+
 ## Project structure
 
 <pre>
@@ -47,10 +51,6 @@ taiko-mono
 ...
 </pre>
 
-## Github Actions
-
-Each commit will automatically trigger the GitHub Actions to run. If any commit message in your push or the HEAD commit of your PR contains the strings [skip ci], [ci skip], [no ci], [skip actions], or [actions skip] workflows triggered on the push or pull_request events will be skipped.
-
 ## Contributors ✨
 
 Thanks goes to these wonderful people! If you would like to contribute, please read the [Contributing guide](./CONTRIBUTING.md). You can also reach out to the community on [Discord](https://discord.gg/taikoxyz).