Skip to content

Latest commit

 

History

History
164 lines (107 loc) · 5.5 KB

CONTRIBUTING.md

File metadata and controls

164 lines (107 loc) · 5.5 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.

Scripts

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

Installiation, Build

  • pnpm run install: setup project by installing dependencies.
  • pnpm run prepack: build package (including docs, expo config plugin)
  • pnpm run build:docs: build documentation at ./docs.
  • pnpm run build:expo-config-plugin: build expo config plugin.

Validation

  • pnpm run lint: lint files with ESLint, ClangFormat, Ktlint, TypeScript
  • pnpm run t: alias for lint
  • pnpm run format: run formatter with ClangFormat, SwiftFormat for iOS codes and Ktlint for Android codes

Example App Build, Manipluations

  • pnpm run start: start the Metro server for the example app.
  • pnpm run android: run the example app on Android.
  • pnpm run ios: run the example app on iOS.
  • pnpm run codegen:{android,ios}: generate codegen output for development typing (this should be clean for running example app, prevetning redelcaration compile error)

Util

  • pnpm run studio: open android studio for example project
  • pnpm run xcode: open xcode for example project

Codegen

  • pnpm run codegen: generate codegen spec for all platform
  • pnpm run codegen:android: generate android codegen spec
  • pnpm run codegen:ios: generate ios codegen spec

Development workflow

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

If you want to use Android Studio or XCode to edit the native code, you can open the example/android or example/ios directories respectively in those editors. To edit the Objective-C or Swift files, open example/ios/example.xcworkspace in XCode and find the source files at Pods > Development Pods > @mj-studio/react-native-naver-map.

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

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

To start the packager:

cd example && pnpm run start

Android

To run the example app on Android:

Set your Naver SDK Key at example/nadroid/app/src/main/res/values/secret.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="naver_client_id">{{your_key}</string>
</resources>
cd example && pnpm run android

iOS

To run the example app on iOS:

Set your Naver SDK key at example/ios/Secret.xcconfig

NAVER_CLIENT_ID = {{your_key}}

pnpm run pod
cd example && pnpm run ios

Type Check & Lint

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

pnpm run lint

Formatting for native codes

There is no linter for android native code yet. But please format code for readability.

Kotlin

Use kotlin standard formatting.

Objective-C

Use .clang-format of project root.

Documentation

Documentation files are located in docs/content/docs/ and use MDX format following Fumadocs conventions.

File Structure:

  • Write MDX files in docs/content/docs/
  • For translations, use .ko.mdx suffix (e.g., index.mdx, index.ko.mdx)
  • Use meta.json to control folder structure and page ordering

Writing Guidelines:

  • Include frontmatter: title, description, icon
  • Start content with h2 (##) headings, not h1 (#)
  • Build with pnpm run build:docs

meta.json:

meta.json controls the sidebar structure and page ordering in each folder. Learn more

{
  "title": "Folder Name",
  "pages": ["index", "setup", "---", "advanced"]
}

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

ESLint, Prettier, TypeScript

We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code. Our pre-commit hooks verify that the linter and tests pass when committing.

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.