Skip to content

Conversation

@kurahaupo
Copy link

@kurahaupo kurahaupo commented Mar 19, 2025

Before submitting your pull request

  • I agree to license my code under the MPL 2.0 license.
  • I rebased my work on top of the main branch.
  • I ran npm test and all tests passed. (n/a)
  • I added test coverages if relevant. (n/a)

Description

"follow the instructions" ... umm, what instructions?

That omission had been bugging me for a while, then today I came across this page in Mozilla Dev.

If there are some other instructions that would be more appropriate, please adjust this accordingly.

Type of change

Select all that apply.

  • Meta-documentation improvement
  • Bug fix
  • New feature
  • Major change (fix or feature that would cause existing functionality to work differently than in the current version)

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

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants