Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 1.6 KB
Raw

Contributing to React Stripe.js

This project is maintained by Stripe and does not accept external pull requests. We welcome bug reports and feature requests as issues.

Issues

React Stripe is a thin wrapper around Stripe.js and Stripe Elements for React. Please only file issues here that you believe represent bugs with React Stripe.js, not Stripe.js itself.

If you're having general trouble with Stripe.js or your Stripe integration, please reach out to us using the form at https://support.stripe.com/email or come chat with us on the Stripe Discord server. We're very proud of our level of service, and we're more than happy to help you out with your integration.

If you've found a bug in React Stripe.js, please let us know! You may also want to check out our issue template.

Developing

Install dependencies:

yarn install

Run the examples using Storybook:

yarn storybook

We use a number of automated checks:

  • Flow, for adding types to JavaScript
    • yarn run flow
  • Jest, for testing
    • yarn test
  • ESLint, for assorted warnings
    • yarn run lint
  • Prettier, for code formatting
    • yarn run prettier

You might want to configure your editor to automatically run these checks. Not passing any of these checks will cause the CI build to fail.