Merge pull request #2671 from kelimuttu/community-docs
Community documentation update
This commit is contained in:
commit
546ee7a098
2 changed files with 19 additions and 2 deletions
|
@ -32,7 +32,23 @@ repository like any other. Before editing files in this folder, you need to:
|
||||||
|
|
||||||
You can then [open a pull request][pr] on [the l10n repository][l10n].
|
You can then [open a pull request][pr] on [the l10n repository][l10n].
|
||||||
|
|
||||||
|
## Tips for contributing
|
||||||
|
|
||||||
|
1. Choose [an issue][issues] that you would like to work on.
|
||||||
|
2. Fork the repository and follow the instructions for setting it up locally.
|
||||||
|
3. Run the add-on locally and try reproducing the issue.
|
||||||
|
4. Debug add-ons by clicking the “Settings” icon in about:addons, and then clicking “Debug Add-ons”
|
||||||
|
5. Click “Inspect” on the MAC add-on to open developer tools for the popup extension (see [this documentation][extension-doc] for more information)
|
||||||
|
6. Once you have a fix ready, commit your changes with the following commit message template: “Fix #<insert issue id #>: <short description>”
|
||||||
|
7. Push your changes and open a pull request for review.
|
||||||
|
|
||||||
|
If you run into an issue, you can always ask the other community members in the [discussions board][discussions].
|
||||||
|
|
||||||
|
<!-- Please keep the list in alphabetical order -->
|
||||||
|
[discussions]: https://github.com/mozilla/multi-account-containers/discussions
|
||||||
|
[extension-doc]: https://extensionworkshop.com/documentation/develop/debugging/
|
||||||
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
|
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
|
||||||
|
[issues]: https://github.com/mozilla/multi-account-containers/issues
|
||||||
[l10n]: https://github.com/mozilla-l10n/multi-account-containers-l10n/
|
[l10n]: https://github.com/mozilla-l10n/multi-account-containers-l10n/
|
||||||
[pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
|
[pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
|
||||||
[web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext
|
[web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext
|
|
@ -13,7 +13,7 @@ Everyone is welcome to contribute to Multi-Account Containers. To learn how
|
||||||
to contribute a patch to Multi-Account Container, please
|
to contribute a patch to Multi-Account Container, please
|
||||||
[read our contributing guide][contributing].
|
[read our contributing guide][contributing].
|
||||||
|
|
||||||
You can also chat with us on [our Matrix room][matrix] or [our forum][forum].
|
You can also chat with us on [our Matrix room][matrix] or ask in [our discussions board][discussions].
|
||||||
|
|
||||||
This repository is governed by Mozilla's code of conduct and etiquette
|
This repository is governed by Mozilla's code of conduct and etiquette
|
||||||
guidelines. For more details, [please read the Mozilla Community Participation Guidelines][cpg].
|
guidelines. For more details, [please read the Mozilla Community Participation Guidelines][cpg].
|
||||||
|
@ -29,4 +29,5 @@ file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||||
[cpg]: https://www.mozilla.org/about/governance/policies/participation/
|
[cpg]: https://www.mozilla.org/about/governance/policies/participation/
|
||||||
[enduser]: https://support.mozilla.org/en-US/kb/containers
|
[enduser]: https://support.mozilla.org/en-US/kb/containers
|
||||||
[forum]: https://discourse.mozilla.org/c/containers/223
|
[forum]: https://discourse.mozilla.org/c/containers/223
|
||||||
|
[discussions]: https://github.com/mozilla/multi-account-containers/discussions
|
||||||
[matrix]: https://matrix.to/#/#containers:mozilla.org
|
[matrix]: https://matrix.to/#/#containers:mozilla.org
|
||||||
|
|
Loading…
Add table
Reference in a new issue