Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.41 KB

Contributing

Thank you for your interest in contributing to our project! We welcome all contributions, big or small, and appreciate your effort to help make our project better.

Getting Started

To start working on the project, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Switch to the packages/core folder and run yarn start to start the project.
  4. Open another terminal and switch to the packages/example folder.
  5. Run yarn test in the packages/example folder to run the tests.
  6. Make your changes and run the tests again to ensure that everything is working correctly.
  7. Once you're satisfied with your changes, commit them and create a pull request.

Reporting Bugs and Issues

If you encounter any bugs or issues while using our project, please submit an issue on our GitHub repository. Please include as much detail as possible, including the steps to reproduce the issue and any relevant error messages.

Submitting Changes

When you're ready to submit your changes, please create a pull request from your forked repository to our main repository. Please include a detailed description of your changes and why they are necessary or beneficial.

We appreciate all contributions, and will do our best to review and respond to your pull request as soon as possible. Thank you for your help in making our project better!