Skip to content

Latest commit

 

History

History
133 lines (92 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

133 lines (92 loc) · 3.77 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.

Development workflow

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

yarn

While it's possible to use npm, the tooling is built around yarn, so you'll have an easier time if you use yarn for development.

While developing, you can run the example app at /examples/testprint-app to test your changes. JavaScript changes are hot-reloaded without a rebuild, while native code and configuration changes requires a full rebuild.

"Old" Architecture

cd examples/testprint-app

# Prebuild Expo with New Architecture disabled
yarn arch:old

# Android
yarn android

# iOS
yarn ios

New Architecture

cd examples/testprint-app

# Prebuild Expo with New Architecture enabled
yarn arch:new

# Android
yarn android

# iOS
yarn ios

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

(NOBRIDGE) LOG  Bridgeless mode is enabled

Linting and Testing

Make sure your code passes TypeScript and ESLint. Run the following to verify:

yarn workspace react-native-citizen-escposprinter lint

To fix formatting errors, run the following:

yarn workspace react-native-citizen-escposprinter lint --fix

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

yarn workspace react-native-citizen-escposprinter test

Creating new functions

  1. Expose the function in src/index.tsx
  2. Create newarch implementation in src/NativeCitizenEscposprinter.ts
  3. Expose the function signature in ios/CitizenEscposprinter.m
  4. Implement the function in ios/CitizenEscposprinter.swift
  5. Create an abstract function in android/src/oldarch/CitizenEscposprinterSpec.kt
  6. Implement the function in android/src/main/java/com/citizenescposprinter/CitizenEscposprinterModule.kt

Commit message convention

We follow the conventional commits specification for our commit messages:

  • fix: bug fixes (PATCH), e.g. fix crash due to deprecated method.
  • feat: new features (MAJOR/MINOR), e.g. add new method to the module.
  • chore: any non semver changes, e.g. CI/CD configs, docs, tests... etc.

Linting and tests

ESLint, Prettier, TypeScript

We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, and Jest for testing.

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

Publishing

This repo relies on semantic-release GitHub Actions to publish new versions, a new version will be published automatically when your PR is merged.

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.