Improve documentation for contributors/maintainers #4934
+131
−106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mcmire
force-pushed
the
update-contributing-docs
branch
5 times, most recently
from
9f9925b
to
6e93383
Compare
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.
mcmire
force-pushed
the
update-contributing-docs
branch
from
6e93383
to
0bd5091
Compare
mcmire
commented
Nov 14, 2024
| @@ -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 | |||
There was a problem hiding this comment.
This section was previously buried at the bottom.
| @@ -148,120 +173,117 @@ To use a preview build for a package within a project, you need to override the | |||
|
|
|||
| 4. Run `yarn install`. | |||
|
|
|||
| ## Adding new packages | |||
| ## Releasing changes | |||
There was a problem hiding this comment.
This section got moved up, and expanded to give people more guidance than before.
| Pay attention to the box you see when you press the green button and ensure that the final name of the commit follows the pattern "Release \<new version\>". | ||
| You're done! | ||
|
|
||
| ## Performing operations across the monorepo |
There was a problem hiding this comment.
I didn't make any changes to this section, so it should be the same.
|
|
||
| ### Handling common errors |
There was a problem hiding this comment.
I'm not sure the "Handling common errors" section is that useful. I've found that people reach out to me if they have issues. We can figure out a way to add it back if we need to.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
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.
README.mdcontributing.mdReferences
As mentioned above, this PR was inspired by a message in Slack, but also inspired by conversations I've had in the past with other teams.
Changelog
N/A
Checklist