Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

43 lines (32 loc) · 1.78 KB
Raw

Contributing to this project

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Please Note: These guidelines are adapted from @necolas's issue-guidelines and serve as an excellent starting point for contributing to any open source project.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Development Process

Here are some guidelines to making changes and preparing your PR:

  1. Make your proposed changes to the repository, along with updating/adding test cases.
  2. (Optional) If you prefer to also test your changes in a real application, you can do the following:
  3. Run yarn link in react-gpt repository.
  4. Run yarn build
  5. cd to your favorite React application, run yarn link @atmedia/react-gpt to point to your local repository.
  6. Run your application to verify your changes. Note, if you are using Next.js or Webpack you might need to clear the webpack cache after making changes, e.g. by running `rm -rf .next/cache/webpack.
  7. Run yarn test to verify all test cases pass.
  8. Run yarn run lint to verify there are no linting errors.

Travis CI Build

N/A

Contributor License Agreement (CLA)

N/A