multi-account-containers/CONTRIBUTING.md
Konstantina Papadea 6d5f06eddd
Update CONTRIBUTING.md
adding tips of contributing
2024-08-22 14:05:43 +02:00

1.8 KiB

Contributing

Requirements

  • Firefox 91.1.0+
  • Git 2.13+
  • Node 7+

Getting Started

  1. Follow the instructions on How to fork a repository

  2. Fetch the locales:

    cd multi-account-containers
    git submodule update --init
    
  3. Install the project dependencies

    npm install --legacy-peer-deps
    
  4. Run npm run dev.

Translations

The translations are located in src/_locales. This directory is a git repository like any other. Before editing files in this folder, you need to:

  1. cd src/_locales/
  2. git checkout -b message-updates-yyyymmdd
  3. git push -u origin message-updates-yyyymmdd

You can then open a pull request on the l10n repository.

##Tips for contributing:

  • Choose an issue from https://github.com/mozilla/multi-account-containers/issues that you would like to work on.
  • Fork the repository and follow the instructions for setting it up locally.
  • Run the add-on locally and try reproducing the issue.
  • Debug add-ons by clicking the “Settings” icon in about:addons, and then clicking “Debug Add-ons”
  • 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)
  • Once you have a fix ready, commit your changes with the following template
  • “Fix #<insert issue id #>: ”
  • Push your changes and open a pull request for review.