diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/bumping_version.md | 33 | ||||
| -rw-r--r-- | docs/publishing.md | 6 | ||||
| -rw-r--r-- | docs/translating-guide.md | 18 |
3 files changed, 54 insertions, 3 deletions
diff --git a/docs/bumping_version.md b/docs/bumping_version.md new file mode 100644 index 000000000..df38369a2 --- /dev/null +++ b/docs/bumping_version.md @@ -0,0 +1,33 @@ +# How to Bump MetaMask's Version Automatically + +``` +npm run version:bump patch +``` + +MetaMask publishes using a loose [semver](https://semver.org/) interpretation. We divide the three segments of our version into three types of version bump: + +## Major + +Means a breaking change, either an API removed, or a major user expectation changed. + +## Minor + +Means a new API or new user feature. + +## Patch + +Means a fix for a bug, or correcting something that should have been assumed to work a different way. + +# Bumping the version + +`npm run version:bump $BUMP_TYPE` where `$BUMP_TYPE` is one of `major`, `minor`, or `patch`. + +This will increment the version in the `app/manifest.json` and `CHANGELOG.md` files according to our current protocol, where the manifest's version is updated, and any line items currently under the changelog's "master" section are now under the new dated version section. + +# Modifying the bump script + +The script that is executed lives [here](../development/run-version-bump.js). +The main functions all live [here](../development/version-bump.js). +The test for this behavior is at `test/unit/development/version-bump-test.js`. + + diff --git a/docs/publishing.md b/docs/publishing.md index 00369acf9..3022b7eda 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -4,15 +4,15 @@ When publishing a new version of MetaMask, we follow this procedure: ## Incrementing Version & Changelog - You must be authorized already on the MetaMask plugin. +Version can be automatically incremented [using our bump script](./bumping-version.md). -1. Update the version in `app/manifest.json` and the Changelog in `CHANGELOG.md`. -2. Visit [the chrome developer dashboard](https://chrome.google.com/webstore/developer/dashboard?authuser=2). +npm run version:bump $BUMP_TYPE` where `$BUMP_TYPE` is one of `major`, `minor`, or `patch`. ## Publishing 1. `npm run dist` to generate the latest build. 2. Publish to chrome store. + - Visit [the chrome developer dashboard](https://chrome.google.com/webstore/developer/dashboard?authuser=2). 3. Publish to firefox addon marketplace. 4. Post on Github releases page. 5. `npm run announce`, post that announcement in our public places. diff --git a/docs/translating-guide.md b/docs/translating-guide.md new file mode 100644 index 000000000..62d444b5a --- /dev/null +++ b/docs/translating-guide.md @@ -0,0 +1,18 @@ +# MetaMask Translation Guide + +The MetaMask browser extension supports new translations added in the form of new locales files added in `app/_locales`. + +- [The MDN Guide to Internationalizing Extensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Internationalization) + +## Adding a new Language + +Each supported language is represented by a folder in `app/_locales` whose name is that language's subtag ([look up a language subtag using this tool](https://r12a.github.io/app-subtags/)). + +Inside that folder there should be a `messages.json` file that follows the specified format. An easy way to start your translation is to first duplicate `app/_locales/en/messages.json` (the english translation), and then update the `message` key for each in-app message. + +That's it! When MetaMask is loaded on a computer with that language set as the system language, they will see your translation instead of the default one. + +## Testing + +To verify that your translation works, you will need to [build a local copy](https://github.com/MetaMask/metamask-extension#building-locally) of MetaMask. + |