diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85016463715..8cfa7fec792 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ guide in some places. - [Style guide](#style-guide) - [Add images](#add-images) - [Format Markdown and MDX](#format-markdown-and-mdx) - - [Live code blocks](#live-code-blocks) + - [Live code blocks](#live-code-blocks) ## Contribution workflow @@ -34,10 +34,10 @@ To contribute changes: 2. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) this repository to your computer and navigate into it. - ```bash - git clone https://github.com/MetaMask/metamask-docs.git - cd metamask-docs - ``` + ```bash + git clone https://github.com/MetaMask/metamask-docs.git + cd metamask-docs + ``` > **Note**: If you don't have write access to this repository, you must [fork the > repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) @@ -56,9 +56,9 @@ To contribute changes: We recommend including the issue number and a short description in the branch name (for example, `183-doc-cli-option`), which is a reminder to fix only one issue in a PR. - ```bash - git checkout -b - - ``` + ```bash + git checkout -b - + ``` > **Tip:** You can use a Git client such as [Fork](https://fork.dev/) instead of the command line. @@ -68,7 +68,6 @@ To contribute changes: and [format your Markdown correctly](https://docs-template.consensys.net/contribute/format-markdown). > **Notes:** - > > - All documentation content is located in the `wallet` and `snaps` directories. > - If you add a new documentation page, make sure to edit `wallet-sidebar.js` or > `snaps-sidebar.js` to add the page to the @@ -82,11 +81,11 @@ To contribute changes: 6. Add and commit your changes, briefly describing your changes in the commit message. Push your changes to the remote origin. - ```bash - git add . - git commit -m "" - git push origin - ``` + ```bash + git add . + git commit -m "" + git push origin + ``` 7. On [this repository on GitHub](https://github.com/MetaMask/metamask-docs), you’ll see a banner prompting you to create a PR with your recent changes. @@ -94,15 +93,15 @@ To contribute changes: [Link the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) that your PR fixes by adding `fixes #` to the PR description. -8. Specific reviewers are automatically requested when you submit a PR. +9. Specific reviewers are automatically requested when you submit a PR. You can request additional reviewers in the right sidebar of your PR – for example, the original issue raiser. Make any required changes to your PR based on reviewer feedback, repeating steps 5–7. 9. After your PR is approved by two reviewers, all checks have passed, and your branch has no - conflicts with the main branch, you can merge your PR. - If you don't have merge access, a maintainer will merge your PR for you. - You can delete the topic branch after your PR is merged. + conflicts with the main branch, you can merge your PR. + If you don't have merge access, a maintainer will merge your PR for you. + You can delete the topic branch after your PR is merged. ## Preview locally @@ -161,9 +160,8 @@ If you need to test analytics events in your local development environment be su ```bash export SEGMENT_ANALYTICS_KEY="" ``` - Then build the project in production mode using the following command: ```bash yarn build && yarn serve -``` +``` \ No newline at end of file diff --git a/README.md b/README.md index eaaff841067..e1b98dacc66 100644 --- a/README.md +++ b/README.md @@ -19,31 +19,31 @@ Build the documentation site locally using the following steps. 1. Clone the repository. - ```bash - git clone https://github.com/MetaMask/metamask-docs.git - cd metamask-docs - ``` - - > **Note:** If you don't have write access to this repository, you must [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) to your personal account and clone your forked repository instead. [Add an upstream remote](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository) to be able to pull from and push to the original repository. - > - > ```bash - > git clone https://github.com//metamask-docs.git - > cd metamask-docs - > git remote add upstream https://github.com/MetaMask/metamask-docs.git - > ``` - + ```bash + git clone https://github.com/MetaMask/metamask-docs.git + cd metamask-docs + ``` + + > **Note:** If you don't have write access to this repository, you must [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) to your personal account and clone your forked repository instead. [Add an upstream remote](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository) to be able to pull from and push to the original repository. + > + > ```bash + > git clone https://github.com//metamask-docs.git + > cd metamask-docs + > git remote add upstream https://github.com/MetaMask/metamask-docs.git + > ``` + 2. Install dependencies. - ```bash - yarn install - ``` - + ```bash + yarn install + ``` + 3. Start the development server. - ```bash - yarn start - ``` - - Once the server starts, you can view the documentation at `http://localhost:3000`. + ```bash + yarn start + ``` + + Once the server starts, you can view the documentation at `http://localhost:3000`. For more information on contributing to the documentation, see the [full contribution guidelines](CONTRIBUTING.md). diff --git a/yarn.lock b/yarn.lock index cc1da083303..5a2c985e001 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8658,9 +8658,9 @@ __metadata: linkType: hard "fast-loops@npm:^1.1.3": - version: 1.1.4 - resolution: "fast-loops@npm:1.1.4" - checksum: 8031a20f465ef35ac4ad98258470250636112d34f7e4efcb4ef21f3ced99df95a1ef1f0d6943df729a1e3e12a9df9319f3019df8cc1a0e0ed5a118bd72e505f9 + version: 1.1.3 + resolution: "fast-loops@npm:1.1.3" + checksum: b674378ba2ed8364ca1a00768636e88b22201c8d010fa62a8588a4cace04f90bac46714c13cf638be82b03438d2fe813600da32291fb47297a1bd7fa6cef0cee languageName: node linkType: hard