Skip to content

Commit 546ee7a

Browse files
authored
Merge pull request #2671 from kelimuttu/community-docs
Community documentation update
2 parents 580fb52 + d8cff7c commit 546ee7a

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

CONTRIBUTING.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,23 @@ repository like any other. Before editing files in this folder, you need to:
3232
3333
You can then [open a pull request][pr] on [the l10n repository][l10n].
3434
35+
## Tips for contributing
36+
37+
1. Choose [an issue][issues] that you would like to work on.
38+
2. Fork the repository and follow the instructions for setting it up locally.
39+
3. Run the add-on locally and try reproducing the issue.
40+
4. Debug add-ons by clicking the “Settings” icon in about:addons, and then clicking “Debug Add-ons”
41+
5. Click “Inspect” on the MAC add-on to open developer tools for the popup extension (see [this documentation][extension-doc] for more information)
42+
6. Once you have a fix ready, commit your changes with the following commit message template: “Fix #<insert issue id #>: <short description>”
43+
7. Push your changes and open a pull request for review.
44+
45+
If you run into an issue, you can always ask the other community members in the [discussions board][discussions].
46+
47+
<!-- Please keep the list in alphabetical order -->
48+
[discussions]: https://github.com/mozilla/multi-account-containers/discussions
49+
[extension-doc]: https://extensionworkshop.com/documentation/develop/debugging/
3550
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
51+
[issues]: https://github.com/mozilla/multi-account-containers/issues
3652
[l10n]: https://github.com/mozilla-l10n/multi-account-containers-l10n/
3753
[pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
38-
[web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext
54+
[web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Everyone is welcome to contribute to Multi-Account Containers. To learn how
1313
to contribute a patch to Multi-Account Container, please
1414
[read our contributing guide][contributing].
1515

16-
You can also chat with us on [our Matrix room][matrix] or [our forum][forum].
16+
You can also chat with us on [our Matrix room][matrix] or ask in [our discussions board][discussions].
1717

1818
This repository is governed by Mozilla's code of conduct and etiquette
1919
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/.
2929
[cpg]: https://www.mozilla.org/about/governance/policies/participation/
3030
[enduser]: https://support.mozilla.org/en-US/kb/containers
3131
[forum]: https://discourse.mozilla.org/c/containers/223
32+
[discussions]: https://github.com/mozilla/multi-account-containers/discussions
3233
[matrix]: https://matrix.to/#/#containers:mozilla.org

0 commit comments

Comments
 (0)