Guide
Workshop
Examples
Contribute
Guide
Workshop
Examples
Contribute

Contribution Guidelines

We truly appreciate your contributions to the Makepad Book! Every contribution is a form of support that helps us continuously improve the Makepad Book and benefit more people who love Makepad.

Raise a Pull Request

  1. Fork this repository to your own GitHub account.
  2. Clone the makepad-book from your GitHub repository to your local machine.
  3. Create a new branch from the preview branch, naming it to something like add/xxx or update/xxx.
  4. Set up your development environment. You can check out the Development Environment Setup section for details.
  5. Change your file locally and complete your work. Raise a Pull Request and make sure all the CI checks pass.
  6. Wait for the Reviewer to review your PR. If needed, make changes based on their feedback or approve their suggestions.
Note

When submitting a Pull Request, keep these points in mind:

  1. Make sure your Pull Request is based on the preview branch and is up-to-date.
  2. Keep the PR small, so each PR addresses just one issue or adds one feature.
  3. Ensure your PR has a clear title and description for the Reviewer to understand.
  4. Include a proper description in the PR and link any relevant issues.

PR Title Format

The PR title should follow the Conventional Commits specification.

For example：

1update(contribute): Add `fooBar` config
2^           ^     ^
3|           |     |__ Subject
4|           |_______ Scope (optional)
5|____________ Type