Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove Submodules Instructions from README and CONTRIBUTING #1188

Merged
merged 1 commit into from
Mar 6, 2024
Merged

Remove Submodules Instructions from README and CONTRIBUTING #1188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 6 additions & 28 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ guide in some places.

- [Contribution workflow](#contribution-workflow)
- [Preview locally](#preview-locally)
- [Update the submodule](#update-the-submodule)
- [Style guide](#style-guide)
- [Add images](#add-images)
- [Format Markdown and MDX](#format-markdown-and-mdx)
Expand Down Expand Up @@ -52,13 +51,7 @@ To contribute changes:
> git remote add upstream https://github.com/MetaMask/metamask-docs.git
> ```
3. [Initialize and update the submodule.](#update-the-submodule)
```bash
git submodule init && git submodule update
```
4. [Create and checkout a topic branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging),
3. [Create and checkout a topic branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging),
naming it appropriately.
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.
Expand All @@ -69,7 +62,7 @@ To contribute changes:
> **Tip:** You can use a Git client such as [Fork](https://fork.dev/) instead of the command line.
5. Open this repository in a text editor of your choice (for example,
4. Open this repository in a text editor of your choice (for example,
[VS Code](https://code.visualstudio.com/)) and make your changes.
Make sure to [follow the style guidelines](https://docs-template.consensys.net/contribute/style-guide)
and [format your Markdown correctly](https://docs-template.consensys.net/contribute/format-markdown).
Expand All @@ -82,10 +75,10 @@ To contribute changes:
> - If you delete, rename, or move a documentation file, make sure to add a
> [redirect](https://docs-template.consensys.net/contribute/configure-docusaurus#redirects).
6. [Preview your changes locally](https://docs-template.consensys.net/contribute/preview) to check
5. [Preview your changes locally](https://docs-template.consensys.net/contribute/preview) to check
that the changes render correctly.
7. Add and commit your changes, briefly describing your changes in the commit message.
6. Add and commit your changes, briefly describing your changes in the commit message.
Push your changes to the remote origin.
```bash
Expand All @@ -94,7 +87,7 @@ To contribute changes:
git push origin
```
8. On [this repository on GitHub](https://github.com/MetaMask/metamask-docs), you’ll see a banner
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.
Create a PR, describing your changes in detail.
[Link the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
Expand All @@ -105,7 +98,7 @@ To contribute changes:
issue raiser.
Make any required changes to your PR based on reviewer feedback, repeating steps 5–7.
10. After your PR is approved by two reviewers, all checks have passed, and your branch has no
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.
Expand All @@ -114,21 +107,6 @@ To contribute changes:

[Preview the docs locally using npm or Yarn.](https://docs-template.consensys.net/contribute/preview)

## Update the submodule

This repository uses the [`keyring-api`](https://github.com/MetaMask/keyring-api) repository as a
Git [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules).

Run the following command to initialize and update the submodule when you first clone the
repository, and every time the submodule's target commit is updated:
```bash
git submodule init && git submodule update
```
> **Note**: You'll see when the submodule's commit is updated when you `git merge` or `git pull`.
> If you have trouble previewing the docs locally, try updating the submodule.
## Style guide

Refer to the [Consensys documentation style guide](https://docs-template.consensys.net/contribute/style-guide).
Expand Down
10 changes: 2 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,13 @@ Build the documentation site locally using the following steps.
> git remote add upstream https://github.com/MetaMask/metamask-docs.git
> ```
2. Initialize and update the [`keyring-api`](https://github.com/MetaMask/keyring-api) submodule.
```bash
git submodule init && git submodule update
```
3. Install dependencies.
2. Install dependencies.
```bash
yarn install
```
4. Start the development server.
3. Start the development server.
```bash
yarn start
Expand Down
Loading