From 7767bb0c58e37aa45b89c866692cb30234981a8b Mon Sep 17 00:00:00 2001 From: kelimuttu Date: Wed, 25 Sep 2024 14:30:48 +0700 Subject: [PATCH 1/3] update the contributor guidelines --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a4a649c..faaff5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,21 @@ 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]. +## Tips for contributing + +1. Choose an issue from https://github.com/mozilla/multi-account-containers/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 https://extensionworkshop.com/documentation/develop/debugging/ for more information) +6. Once you have a fix ready, commit your changes with the following commit message template: “Fix #: ” +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]. + [fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo [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 [web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext +[discussions]: https://github.com/mozilla/multi-account-containers/discussions + From e6e7d5178e97a36267303f783feefc8fc7c0b079 Mon Sep 17 00:00:00 2001 From: kelimuttu Date: Wed, 25 Sep 2024 14:32:18 +0700 Subject: [PATCH 2/3] remove discourse and redirect to GH discussions board --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b97cca..92f79c3 100644 --- a/README.md +++ b/README.md @@ -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 [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 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/ [enduser]: https://support.mozilla.org/en-US/kb/containers [forum]: https://discourse.mozilla.org/c/containers/223 +[discussions]: https://github.com/mozilla/multi-account-containers/discussions [matrix]: https://matrix.to/#/#containers:mozilla.org From d8cff7ca41bda2d4b2871f7c2aacce6f99097071 Mon Sep 17 00:00:00 2001 From: kelimuttu Date: Wed, 25 Sep 2024 14:37:53 +0700 Subject: [PATCH 3/3] tidy up links --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index faaff5e..aa31ca8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,19 +34,21 @@ You can then [open a pull request][pr] on [the l10n repository][l10n]. ## Tips for contributing -1. Choose an issue from https://github.com/mozilla/multi-account-containers/issues that you would like to work on. +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 https://extensionworkshop.com/documentation/develop/debugging/ for more information) +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 #: ” 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]. + +[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 +[issues]: https://github.com/mozilla/multi-account-containers/issues [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 -[web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext -[discussions]: https://github.com/mozilla/multi-account-containers/discussions - +[web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext \ No newline at end of file