Skip to content

Link to local installation instructions in CONTRIBUTING.md #2732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Link to local installation instructions in CONTRIBUTING.md #2732

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ 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.
2. Fork the repository and follow the [instructions for setting it up locally](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be better to recommend that contributors run npm run dev? That uses web-ext to automatically install the add-on in a temporary instance of Firefox.

Copy link
Author

@kurahaupo kurahaupo Sep 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm aiming to add a link under the existing text, not to rewrite the text, since that's a job for someone who understands it much better than me. But in the meantime, having some instructions is better than none.

When I try using npm I simply get:
npm: command not found

That said, I'm sure npm will be the simpler option for many, but without a gazillion gigabytes of RAM, running extra instances of Firefox is painful. I'd rather just install it in my normal instance, so that I can test it with my normal workflow using all my other plugins. (Especially it's critical to me that FoxyProxy is active.)

So how about mentioning both options? In particular, how about including that one-line option on the target page?

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)
Expand All @@ -51,4 +51,4 @@ If you run into an issue, you can always ask the other community members in the
[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
[web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext