rnx-kit/CONTRIBUTING.md

Contributing

This project welcomes contributions and suggestions!

• Contributor License Agreement
• Code of Conduct
• Requirements
• Build
• Change Logs
• Releases
• Style Guide

Contributor License Agreement

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Requirements

• Node LTS (see releases for specific versions)
• Yarn Classic

Optional

• Android:
  • Android Studio 4.2 or later
    • Android SDK Platform 29
    • Android SDK Build-Tools 30.0.3
    • To install the required SDKs, go into Preferences ❭ Appearance & Behavior ❭ System Settings ❭ Android SDK.
• iOS/macOS:
  • Xcode 12 or later
  • CocoaPods
• Windows:
  • Ensure that Developer Mode is turned on in Windows Settings app
  • Install development dependencies as described in the React Native for Windows documentation

Build

We use Yarn to install npm dependencies. From the repo root, run:

yarn

This will also take care of building any tools that you might need. Once it's done, you can choose to build all packages or just the packages you're interested in.

If you want to build all packages, you should run:

yarn build

Otherwise, you can specify which package to build, e.g. @rnx-kit/cli:

yarn build-scope @rnx-kit/cli

Alternatively, you can navigate to the package folder and run:

cd packages/cli
yarn build --dependencies

Both the repository level build-scope and the package local build --dependencies ensure all dependencies are built before the target package.

Below is a table of commonly used commands and what they do depending on your current working directory.

Command	Repository Level	Package Level
yarn build	Builds all packages in the repository	Builds the current package only
yarn build --dependencies	--	Builds the current package and its dependencies
yarn build-scope	Builds the specified package and its dependencies	--
yarn format	Formats all packages in the repository	Formats the current package only
yarn lint	Lints all packages in the repository	Lints the current package only
yarn test	Tests all packages in the repository	Tests the current package only

Change Logs

Each package in this monorepo contains a change log. The log is built from change descriptions submitted with each PR.

$ yarn change

Checking for changes against "origin/main"
fetching latest from remotes "origin/main"
Found changes in the following packages:
  @rnx-kit/cli
  @rnx-kit/config
  ...

Please describe the changes for: @rnx-kit/cli
? Change type › - Use arrow-keys. Return to submit.
❯   Patch      - bug fixes; no API changes.
    Minor      - small feature; backwards compatible API changes.
    None       - this change does not affect the published package in any way.

Follow the prompts and describe the changes you are making to each package. This information is written in files under /change. Our CI loop uses these files to bump package versions and update package change logs. The entire process is coordinated by Beachball.

Releases

Our release process is fully automated by Beachball.

When a PR is merged, our CI loop uses Beachball to version-bump each changed package and publish it to npm.

Style Guide

Most files are formatted with Prettier. We also use ESLint to lint all JavaScript code.

You can trigger formatting by running yarn format, and linting with yarn lint.