Skip to main content

Contributing

Contributions are welcome! Here's how you can help.

Ways to help​

  • Report a bug — Open a GitHub issue with a minimal reproduction.
  • Request an icon — Icon suggestions belong upstream at remixicon/remixicon. Once merged there, the next rn-remixicon release will pick them up automatically.
  • Improve the docs — Found something unclear? Edit the markdown files in docs/docs/ and open a PR.
  • Submit a pull request — See the dev setup below.

Dev setup​

# 1. Fork and clone
git clone https://github.com/<your-fork>/rn-remixicon.git
cd rn-remixicon

# 2. Install dependencies
npm install   # or yarn install

# 3. Build the package
npm run build

The build script runs the SVGR pipeline (compile) and then TypeScript compilation (tsc). The output lands in dist/.

Regenerating icons​

Icons are generated from raw SVGs in src/svg/ using @svgr/cli. To regenerate after adding or updating SVGs:

npm run compile

This rewrites src/icons/ with fresh React Native SVG components and updates the index. Run npm run build afterwards to compile TypeScript.

Code style​

  • Formatting: Prettier — run npx prettier --write . before committing.
  • Linting: ESLint — run npx eslint . to check.
  • Commits: Follow Conventional Commits (feat:, fix:, docs:, chore:, etc.).

License​

This project is MIT licensed. By contributing you agree that your changes will be released under the same license.