Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (53 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 1.67 KB

How to Contribute

  1. Clone this repository:
git clone https://github.com/pmndrs/react-spring
cd react-spring

  1. Install yarn (https://yarnpkg.com/en/docs/install)

  2. Bootstrap the packages:

yarn

# Clone the docs (optional)
yarn meta git update
  1. Link the packages:
# Use the .js bundles
yarn lerna exec 'cd dist && yarn link || exit 0'

# Or use the uncompiled .ts packages
yarn lerna exec 'yarn link'
  1. Link react-spring to your project:
cd ~/my-project
yarn link react-spring
  1. Let's get cooking! 👨🏻‍🍳🥓

Guidelines

Be sure your commit messages follow this specification: https://www.conventionalcommits.org/en/v1.0.0-beta.4/

Duplicate react errors

React 16.8+ has global state to support its "hooks" feature, so you need to ensure only one copy of react exists in your program. Otherwise, you'll most likely see this error. Please try the following solutions, and let us know if it still doesn't work for you.

  • For create-react-app users: Follow this guide: facebook/react#13991 (comment)

  • For webpack users: Add an alias to webpack.config.js like this:

    alias: {
  react: path.resolve('node_modules/react'),
}

  • For gatsby users: Install gatsby-plugin-alias-imports and add this to your gatsby-config.js module:

    {
  resolve: `gatsby-plugin-alias-imports`,
  options: {
    alias: {
      react: path.resolve('node_modules/react'),
    },
  },
},

Publishing

To publish a new version:

yarn release major | minor | patch  --tag