Skip to content

Commit 9f9925b

Browse files
committed
Improve documentation for contributors/maintainers
It was pointed out recently that the link to the Contributing guide is buried at the bottom of the README. This commit makes it more prominent by moving it to the top and lists the major sections of the document. However, this commit also updates the Contributing guide to be more generally helpful and to answer questions that I've received from other teams not familiar with this repo who are unaware that codeownership and releases are shared among teams.
1 parent 1e7d70e commit 9f9925b

File tree

2 files changed

+130
-106
lines changed

2 files changed

+130
-106
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,21 @@
22

33
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/)).
44

5-
## Modules
5+
## Contributing
66

7-
This repository contains the following packages [^fn1]:
7+
See the [Contributor Guide](./docs/contributing.md) for help on:
8+
9+
- Setting up your development environment
10+
- Working with the monorepo
11+
- Testing changes in clients
12+
- Issuing new releases
13+
- Creating a new package
14+
15+
## Installation/Usage
16+
17+
Each package in this repository has its own README where you can find installation and usage instructions. See `packages/` for more.
18+
19+
## Packages
820

921
<!-- start package list -->
1022

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

4759
<!-- end package list -->
4860

49-
Or, in graph form [^fn1]:
50-
5161
<!-- start dependency graph -->
5262

5363
```mermaid
@@ -188,10 +198,4 @@ linkStyle default opacity:0.5
188198

189199
<!-- end dependency graph -->
190200

191-
Refer to individual packages for usage instructions.
192-
193-
## Learn more
194-
195-
For instructions on performing common development-related tasks, see [contributing to the monorepo](./docs/contributing.md).
196-
197-
[^fn1]: The package list and dependency graph should be programmatically generated by running `yarn update-readme-content`.
201+
(This section may be regenerated at any time by running `yarn update-readme-content`.)

0 commit comments

Comments
 (0)