Mention ARCHITECTURE.md in CONTRIBUTING.md

typed-ember · Oct 5, 2022 · 1103116 · 1103116
1 parent 0f33870
commit 1103116
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,5 +14,6 @@ Glint is a family of packages which all live in this repo as a Yarn workspace. T
 - Clone the repo.
 - Run `yarn` in the root of the repo to install all the package dependencies. If you have Volta installed, it will automatically fetch and use the correct versions of Node and Yarn for you.
 - Run `yarn build` in the root of the repository to build all of the projects the first time. This will make sure that once you start working on one of the packages, you are working with an up to date version of the other packages in the project it depends on.
+- Read the project’s [ARCHITECTURE.md](./ARCHITECTURE.md) to understand the basics of how the code base works.
 
-Once you have the changes made and added tests to confirm they work correctly, you can then open a PR and we'll work with you to polish it up and get it landed!
+Once you have made changes and added tests to confirm they work correctly, you can then open a PR and we'll work with you to polish it up and get it landed!