Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 2.76 KB
Raw

Contributing to Expo Preview Action

📦 Download and Setup

  1. Fork this repository to your own GitHub account and then clone it to your local device. (git remote add upstream [email protected]:expo/expo-preview-action.git 😉)
  2. Make sure you have the following packages globally installed on your system:
    • node (active Node LTS or higher is recommended)
    • yarn
  3. Install the Node packages (yarn install)

🏎️ Running a custom version

To try out your changed with Github Action, you have to reference your fork and/or branch or commit reference in the workflow you want to try. After that, you have two options:

  1. Run the workflow in Github Actions itself by triggering your workflow.
  2. Run the workflow locally with nektos/act.

✅ Testing

Testing is done using Jest. Run yarn test to run Jest.

In CI we are running tests on multiple Node versions using Windows, Linux, and MacOS. Make sure they are passing for your PR.

📝 Writing a Commit Message

If this is your first time committing to a large public repo, you could look through this neat tutorial: "How to Write a Git Commit Message"

Commit messages are formatted using the Conventional Commits format. You can take a look at .releaserc.js for the allowed commit types.

docs: fix typo in xxx
feature: add support for SDK 40
chore: add test-case for custom completions
fix: improve logging for errors
refactor: update loading icon

🔎 Before Submitting a PR

To get your PR merged as fast as possible, please make sure you have done the following:

  • Run yarn lint --fix to fix the formatting of the code. Ensure that yarn lint succeeds without errors or warnings.
  • Run yarn test to make sure all normal use cases are passing.
  • Run yarn build to ensure the build is up-to-date and runs correctly and without errors or warnings.

🚀 Releasing a new version

To release a new version for Github Actions, we have to create a new release in Github. You can run the Release workflow to generate a new version, changelog, and Github release.

After the exact version tag is created, update the v{major} tag to the latest major version. Make sure you are on the default branch at the commit of versioning.

$ git checkout main
$ git fetch --tags && git pull
$ git tag --force v{major}
$ git push --force --tags