Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 1.29 KB

Contributing

Thank you for your interest in contributing to React-Mentions! This project is made possible by contributors like you, and we welcome any contributions to the code-base and the documentation.

Environment

  • Ensure you have the latest version of Node and Yarn.
  • Run yarn to install all needed dev dependencies.

Making Changes

Pull requests are encouraged. If you want to add a feature or fix a bug:

  1. Fork and clone the repository
  2. Create a separate branch for your changes
  3. Make your changes, and ensure that it is formatted by Prettier
  4. Write tests that validate your change and/or fix.
  5. Run yarn build and then run tests with yarn test
  6. If coding a new feature, please add the examples to the example app (/demo/src/examples) and add the docs to the README.md file.
  7. Create a changeset by running yarn changeset. More info.
  8. Push your branch and open a PR 🚀