Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

36 lines (21 loc) · 1.45 KB
Raw

Magic Lottery Contributing Guide

Hi! We're really excited that you're interested in contributing to Magic Lottery!

Before submitting your comtribution, please read through the fllowing guide.

Repo Setup

To develop locally, fork this repository and clone it in your local machine. The package manager used to install and link dependencies must be pnpm.

To develop and test the lib:

  1. Run pnpm i in Magic Lottery's root folder.
  2. Run pnpm build in Magic Lottery's root folder.

Running Test

  1. Run pnpm test in Magic Lottery's root folder.

Running Document

  1. Run pnpm docs:dev in Magic Lottery's root folder and open http://127.0.0.1:5173 in your browser.

Pull Request Guidelines

  1. Before you submit your pull request, make sure to review your changes thoroughly. This includes running all tests and checking for any performance issues.
  2. In your pull request description, please include a detailed explanation of your changes and why you think they are necessary.
  3. Make sure your code adheres to our coding standards and conventions.
  4. Your pull request will be reviewed by one of the maintainers. Please be patient and address any feedback you receive.
  5. Once your pull request is approved, it will be merged into the main branch.

For any additional questions, please contact [email protected].

License

By contributing to Magic Lottery, you agree that your contributions will be licensed under its MIT license.