Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 4.72 KB
Raw

Contributing

I'm very open to contributions, big and small! For general instructions on submitting a pull request on GitHub, see these guides: Fork A Repo, and Creating a pull request from a fork.

Table of Contents

Changes to the plugin

In order to build the project, you will first need to install npm, and then run npm install to install the project's dependencies.

If you want to try out a demo playground for the component:

  1. Start the server by running npm run server.
  2. Open the demo page in your browser at the address printed to your console.

Tests are broken up into two parts. We are currently porting the existing test suite from Grunt & Jasmine to Jest.

  • To run all tests, run npm test.
  • To only run the new tests, run npm run jest.
  • To only run the old tests, run npx grunt jasmine:test.
  • To run & debug the old tests interactively in your browser, run: npx grunt jasmine:interactive and load the URL it prints out in your browser.

Any time you make changes, you’ll need to re-build the plugin. Most tests run against the builds, so after making changes, you’ll need to do a build before running tests.

  • To do a complete build, run npm run build
  • To build just the JS:
    • npm run build:js runs various checks (linting, etc.) and then builds.
    • npm run build:jsfast just builds the JS. This is useful when iterating and testing small changes. Make sure you eventually do a full build with all the checks, though!
  • To build just the CSS, run npm run build:css.

Updating to a new version of libphonenumber

Step 1: Setup

We now include libphonenumber as a submodule within this repository. The first time you update your local intl-tel-input repo to include this change, you need to run npm install in the root intl-tel-input directory to install the new closure-compiler dependencies, and then run git pull --recurse-submodules to initialise the submodule (this will populate the third_party/libphonenumber directory).

Step 2: Updating libphonenumber

First, cd into the libphonenumber submodule directory and checkout the required version tag e.g.

  cd third_party/libphonenumber
  git fetch --tags
  git checkout v8.9.14

Then to build the new version of utils.js, cd back to the root of your intl-tel-input repo and run the build command:

  cd ../..
  npm run build:utils

Then run the tests to make sure nothing has broken: npm test, commit the updated build/js/utils.js, and create a pull request on Github.

Updating the flag images

We get our flags from the flag-icons project. If there is a problem with the flags, you'll need to raise it with them. When there is an update in that project that you want to pull into this project, you can update the npm package with npm install flag-icons@VERSION --save-dev, and then re-build the flag sprite images with npm run build:img. Once you've checked everything looks ok (e.g. by opening the included demo.html in your browser), you can then create a pull request on Github.

Adding a new translation

If we don't currently support a language you need, it's easy to contribute this yourself - you only need to provide a handful of UI translation strings (e.g. the country search input placeholder text), as we automatically pull in the country names from the country-list project. The translation files can be found in src/js/intl-tel-input/i18n/. There is a directory for each language we support (e.g. "en" for "English"). Inside each of these directories, you will find 3 files: countries.ts which contains the (auto-generated) country name translations, interface.ts which contains the user interface translations, and index.ts (also auto-generated) which ties it all together. All you need to do to add a new translation is create a new language directory, create the interface.ts file and populate it with your translations, following the same pattern as the other languages e.g. see the english version here. If you haven't already, you will need to run npm install to install the project dependencies, and then you can run npm run build:translations to auto-generate the countries.ts for your new language, as well as the required build files, and then you can create a pull request on Github.