Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
229 lines (146 loc) · 8.81 KB

CONTRIBUTING.md

File metadata and controls

229 lines (146 loc) · 8.81 KB

Contributing

Contributions are always welcome, no matter how large or small!

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the code of conduct.

If you have found an issue or would like to request a new feature, simply create a new issue. Be sure to fill out as much information as possible.

Reporting Bugs & Feature Requests

If you would like to submit a feature request or report a bug, we encourage you to first look through the issues and pull requests before filing a new issue.

Submitting a Pull Request

If you wish to submit a pull request for a new feature or issue, you should start by forking this repository first. This should get you setup on your local machine:

Development workflow

This project is a monorepo managed using pnpm workspaces. It contains the following packages:

  • The library packages in packages/common and packages/get-image
  • Example apps in packages/icon-explorer and packages/directory
  • Fonts in packages/fontname e.g. packages/fontawesome6

To get started with the project, run pnpm install in the root directory to install the required dependencies for each package:

pnpm install

Since the project relies on pnpm workspaces, you cannot use npm for development.

IconExplorer demonstrates usage of the library. You need to run it to test any changes you make.

It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app.

If you want to use Android Studio or XCode to edit the native code, you can open the packages/IconExplorer/android or packages/IconExplorer/ios directories respectively in those editors. To edit the Objective-C or Swift files, open packages/IconExplorer/ios/IconExplorer.xcworkspace in XCode and find the source files at Pods > Development Pods > @react-native-vector-icons/ant-design.

To edit the Java or Kotlin files, open packages/icon-explorer/android in Android studio and find the source files at react-native-vector-icons under Android.

You can use various commands from the root directory to work with the project.

To start the packager:

pnpm run example start

To run the example app on Android:

pnpm run example android

To run the example app on iOS:

pnpm run example ios

By default, the example is configured to build with the old architecture. To run the example with the new architecture, you can do the following:

  1. For Android, run:

    ORG_GRADLE_PROJECT_newArchEnabled=true pnpm run example android

  2. For iOS, run:

    RCT_NEW_ARCH_ENABLED=1 pod install example/ios
pnpm run example ios

If you are building for a different architecture than your previous build, make sure to remove the build folders first. You can run the following command to cleanup all build folders:

pnpm run clean

To confirm that the app is running with the new architecture, you can check the Metro logs for a message like this:

Running "IconExplorer" with {"fabric":true,"initialProps":{"concurrentRoot":true},"rootTag":1}

Note the "fabric":true and "concurrentRoot":true properties.

Make sure your code passes all of our linting. Run the following to verify:

pnpm run lint

To fix formatting errors, run the following:

pnpm run lint:biome --fix

Remember to add tests for your change if possible. Run the unit tests by:

pnpm run test

Tests

We run tests again new and old architecture against the last 3 versions of React Native automatically via CI.

To run the these tests manually you should create an avd called test which is based on the Pixel 6 Pro profile. This is essential for the screenshot diffs to work

sdkmanager --install 'system-images;android-31;default;x86_64' --channel=0
avdmanager create avd --force -n test --abi 'default/x86_64' --package 'system-images;android-31;default;x86_64' --device 'pixel_6_pro'

You can then run the tests

cd packages/icon-explorer
pnpm run run test:android:build
pnpm run run test:android:run
pnpm run run test:ios:build
pnpm run run test:ios:run

You can switch versions of react native before running the tests with

cd packages/icon-explorer
# ./set-rn-version <arch> <version>
./set-rn-version new 0.74
./set-rn-version old 0.79

Commit message convention

We follow the conventional commits specification for our commit messages:

  • fix: bug fixes, e.g. fix crash due to deprecated method.
  • feat: new features, e.g. add new method to the module.
  • refactor: code refactor, e.g. migrate from class components to hooks.
  • docs: changes into documentation, e.g. add usage example for the module..
  • test: adding or updating tests, e.g. add integration tests using detox.
  • chore: tooling changes, e.g. change CI config.

Our pre-commit hooks verify that your commit message matches this format when committing.

Linting and tests

We use TypeScript for type checking, Biome for linting and formatting the code, and Jest for testing.

Our pre-commit hooks verify that the linter and tests pass when committing.

Publishing to npm

We use nx to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.

To publish new versions, use the github action release.yml which is triggered manually.

Scripts

The package.json file contains various scripts for common tasks:

  • pnpm i: setup project by installing dependencies.
  • pnpm run lint:typecheck: type-check files with TypeScript.
  • pnpm run lint:biome: lint files with Biome.
  • pnpm run lint:knip: lint files with knip.

Sending a pull request

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify that linters and tests are passing.
  • Review the documentation to make sure it looks good.
  • Follow the pull request template when opening a pull request.
  • For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.

Font generation

All the font packages are automatically generated using a yeoman generator. This is driven by a .yo-rc.json file in the root of each font.

To make changes to common font files, edit the files in packages/generator-react-native-vector-icons/src/app/templates/ and then at the root run:

# Generate all fonts
pnpm generate

# Generate a single font
pnpm generate ant-design

The generator requires:

  • Docker — needed for SVG-based fonts (ant-design, entypo, evil-icons, feather) which use fontcustom to compile SVGs into .ttf files.
  • FontAwesome Pro npm token — needed for pro font packages. The token is read from your npm config (//npm.fontawesome.com/:_authToken). If not set, the generator will prompt for it.

After changing the generator templates, rebuild the generator before running pnpm generate:

cd packages/generator-react-native-vector-icons
pnpm prepare

Custom font packages

Some packages (icomoon, fontello, and all fontawesome-pro-* variants) have copyCustomFonts: true in their .yo-rc.json. These packages do not ship font files — users must provide them in a rnvi-fonts/<package-name>/ directory in their app.

On iOS, the podspec copies fonts from rnvi-fonts/ into the pod's fonts/ directory during pod install. This is necessary because CocoaPods cannot resolve s.resources paths that traverse out of a symlinked pod directory (common in monorepos using pnpm/yarn workspaces).

Testing pro fonts in the icon-explorer

The icon-explorer app needs FontAwesome Pro font files to test pro icon packages. These cannot be checked into git. To set them up:

cd packages/icon-explorer
pnpm fetch-pro-fonts

This downloads FontAwesome Pro v5 and v6 fonts and places them in rnvi-fonts/fontawesome5-pro/ and rnvi-fonts/fontawesome6-pro/, renamed to match the filenames expected by each package.

Font versioning

Font package versions are now independent of upstream font versions, and we track the mapping in the README.md of each font