Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1.14 KB

Before You Contribute

Raise an Issue First

Before you invest a significant amount of time on a change, please create a issue describing your proposal. This will help us to make sure that the change is in line with the project's goals, roadmap and avoid duplicate work.

Avoid Dependencies

We want to keep the project as lightweight as possible. So, please avoid adding any new dependencies unless it's absolutely necessary.


Contributing

  • Fork the repository on GitHub to your personal account.
  • Clone your forked repository to your local development environment.
  • Create a new branch for your feature or bug fix: git checkout -b your-branch-name
  • Install the project dependencies: pnpm i
  • Run the project in development mode: pnpm dev
  • Make changes to your local repository.
  • Commit your changes and push them to your forked repository.
  • Open a pull request from your forked repository to the dev branch of this repository.

Code Licensing

Your contributions are subject to the project's open-source(MIT) license. By submitting a PR, you agree to release your code under this license.

Thanks for your contribution!