Skip to content

Improve documentation for contributors/maintainers #4934

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

Merged
merged 5 commits into from
Nov 15, 2024
Merged

Improve documentation for contributors/maintainers #4934

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0bd5091
Improve documentation for contributors/maintainers
mcmire Nov 14, 2024
09d4d31
Tweak contributing.md
mcmire Nov 14, 2024
300f74b
Fix typo
mcmire Nov 14, 2024
dad0444
Merge branch 'main' into update-contributing-docs
mcmire Nov 15, 2024
ca63184
Merge branch 'main' into update-contributing-docs
mcmire Nov 15, 2024
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
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,21 @@

This monorepo is a collection of packages used across multiple MetaMask clients (e.g. [`metamask-extension`](https://github.com/MetaMask/metamask-extension/), [`metamask-mobile`](https://github.com/MetaMask/metamask-mobile/)).

## Modules
## Contributing
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section was previously buried at the bottom.


This repository contains the following packages [^fn1]:
See the [Contributor Guide](./docs/contributing.md) for help on:

- Setting up your development environment
- Working with the monorepo
- Testing changes in clients
- Issuing new releases
- Creating a new package

## Installation/Usage

Each package in this repository has its own README where you can find installation and usage instructions. See `packages/` for more.

## Packages

<!-- start package list -->

Expand Down Expand Up @@ -46,8 +58,6 @@ This repository contains the following packages [^fn1]:

<!-- end package list -->

Or, in graph form [^fn1]:

<!-- start dependency graph -->

```mermaid
Expand Down Expand Up @@ -188,10 +198,4 @@ linkStyle default opacity:0.5

<!-- end dependency graph -->

Refer to individual packages for usage instructions.

## Learn more

For instructions on performing common development-related tasks, see [contributing to the monorepo](./docs/contributing.md).

[^fn1]: The package list and dependency graph should be programmatically generated by running `yarn update-readme-content`.
(This section may be regenerated at any time by running `yarn update-readme-content`.)
Loading
Loading