From f987f96f5013cd7ba7fe4ba4f2e4268097848e31 Mon Sep 17 00:00:00 2001
From: Gauthier Petetin <gauthierpetetin@hotmail.com>
Date: Thu, 6 Jun 2024 21:54:45 +0200
Subject: [PATCH] feat: contributor docs (#25095)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## **Description**

This PR aims to add a link to contributor docs in the PR template and in
the README, to foster adoption of contributor docs guidelines.

[Same PR for Mobile
repo.](https://github.com/MetaMask/metamask-mobile/pull/9884)

## **Related issues**

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/1843

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

---------

Co-authored-by: Mark Stacey <markjstacey@gmail.com>
---
 .github/pull-request-template.md | 2 +-
 README.md                        | 4 +++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md
index b537ef94a5fd..59232248ef51 100644
--- a/.github/pull-request-template.md
+++ b/.github/pull-request-template.md
@@ -38,7 +38,7 @@ Fixes:
 
 ## **Pre-merge author checklist**
 
-- [ ] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
+- [ ] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
 - [ ] I've completed the PR template to the best of my ability
 - [ ] I’ve included tests if applicable
 - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable
diff --git a/README.md b/README.md
index f451e6d3aa7c..efa0be51019b 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,9 @@ For up to the minute news, follow our [Twitter](https://twitter.com/metamask) or
 
 To learn how to develop MetaMask-compatible applications, visit our [Developer Docs](https://metamask.github.io/metamask-docs/).
 
-To learn how to contribute to the MetaMask project itself, visit our [Internal Docs](https://github.com/MetaMask/metamask-extension/tree/develop/docs).
+To learn how to contribute to the MetaMask codebase, visit our [Contributor Docs](https://github.com/MetaMask/contributor-docs).
+
+To learn how to contribute to the MetaMask Extension project itself, visit our [Extension Docs](https://github.com/MetaMask/metamask-extension/tree/develop/docs).
 
 ## GitHub Codespaces quickstart