You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,21 @@
2
2
3
3
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/)).
4
4
5
-
## Modules
5
+
## Contributing
6
6
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
8
20
9
21
<!-- start package list -->
10
22
@@ -46,8 +58,6 @@ This repository contains the following packages [^fn1]:
0 commit comments