Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 1.66 KB

Contributing

We are open to, and grateful for, any contributions made by the community.

Reporting Issues

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Development

Visit the Issue tracker to find a list of open issues that need attention.

Fork, then clone the repo:

git clone https://github.com/your-username/react-text-loop.git

Build package for dev mode. It will automatically watch any changes in src/ forlder:

yarn run dev

We follow eslint-config-edited for code style.

Building and testing

Build package:

yarn run build

To run the tests:

npm run test

To perform linting with eslint, run the following:

npm run lint

New Features

Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

Submitting Changes

  • Open a new issue in the Issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the master branch.
  • Make sure all tests pass and there are no linting errors.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!