Merge pull request #80 from OpenZeppelin/chore/update-readme

chore: updated readme

Author: stevedylandev

.github/pull_request_template.md

@@ -19,9 +19,9 @@ Fixes #
 Relates to #
 
 ### Checklist
-- [ ] Build succeeds locall with `pnpm run build`
+- [ ] Build succeeds locally with `pnpm run build`
 - [ ] Lint is successful when running `pnpm run check`
-- [ ] Docs follow [OpenZeppelin Documentation Standards](../STANDARDS.md)
+- [ ] Docs follow [OpenZeppelin Documentation Standards](https://github.com/OpenZeppelin/docs/blob/main/STANDARDS.md)
 
 ### Additional Notes
 <!-- Any additional context, concerns, or information for reviewers -->

CONTRIBUTING.md

@@ -10,7 +10,7 @@ Please follow this guide if you have something to contribute.
 
 If you find a bug or have a suggestion for improvement:
 
-1. Check if the issue already exists in [GitHub issues]()
+1. Check if the issue already exists in [GitHub issues](https://github.com/OpenZeppelin/docs/issues)
 2. If not, create a new issue with a clear description
 3. Wait for a team member to comment before moving forward with a pull request
 
@@ -19,8 +19,9 @@ If you find a bug or have a suggestion for improvement:
 1. Fork the repository
 2. Create a new branch for your change
 3. Follow the local development guide in the [README](README.md) or with the steps [below](#development-setup)
-4. Use [conventional commits]() when making changes
-5. Submit a pull request
+4. Use [conventional commits](https://www.conventionalcommits.org/) when making changes
+5. Make sure your changes follow the [OpenZeppelin Docs Standards](STANDARDS.md)
+6. Submit a pull request
 
 ### Pull Request Guidelines
 

README.md

@@ -2,7 +2,7 @@
 
 ![cover](public/social.png)
 
-Welcome to the OpenZeppelin Docs repo! Before opening an issue or creating a PR please consult our [contribution guide](CONTRIBUTING.md)
+Welcome to the OpenZeppelin Docs repo! Before opening an issue or creating a PR please consult our [contribution guide](CONTRIBUTING.md) as well as the [OpenZeppelin Documentation Standards](STANDARDS.md)
 
 ## Development
 
@@ -30,6 +30,13 @@ pnpm install
 pnpm dev
 ```
 
+**4. Run `build` and `lint`**
+
+```bash
+pnpm run build
+pnpm run check
+```
+
 ## Project Structure
 
 ### Content Organization