Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (58 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

92 lines (58 loc) · 3.32 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

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

  • The library package in the root directory.
  • An example app in the example/ directory.

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

yarn

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

The example app 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 to edit the native code, you can open the example/android directory in those editors.

To edit the Java or Kotlin files, open example/android in Android studio and find the source files at react-native-mapsforge-vtm under Android.

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

To start the packager:

yarn example start

To run the example app on Android:

yarn example android

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

yarn typecheck

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

yarn test

Linting and tests

We use TypeScript for type checking and in future Jest for testing.

Publishing to npm

We use a script to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.

To publish new versions, run the following:

yarn run publish <version> && npm publish

Scripts

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

  • yarn: setup project by installing dependencies.
  • yarn typecheck: type-check files with TypeScript.
  • yarn lint: lint files with ESLint.
  • yarn test: run unit tests with Jest.
  • yarn example start: start the Metro server for the example app.
  • yarn example android: run the example app on Android.

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:

  • The development branch is called development. This should be the pull request base.
  • 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.