Skip to content

Latest commit

聽

History

History
34 lines (21 loc) 路 1.28 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) 路 1.28 KB
Raw

Contributing to React Portable

First off, thank you for considering contributing to React Portable. It's people like you that make React Portable such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Setup

This project is built with a yarn workspace. Here's how you can set it up on your local machine:

  1. Fork the project.
  2. Clone your fork.
  3. Install the dependencies with yarn install.

Making Changes

When you're ready to start working on an issue, follow these steps:

  1. Create a new branch (git checkout -b new-feature).
  2. Make the changes you'd like to introduce.
  3. Test your changes with yarn test.
  4. Commit your changes (git commit -am 'Add some feature').
  5. Push to the branch (git push origin new-feature).
  6. Create a new Pull Request.

Coding Standards

Please follow the existing coding style.

Reporting Bugs

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Thank you again for taking the time to contribute!