To submit a pull request:
- Fork the repository and create a feature branch. (Existing contributors can create feature branches without forking. Prefix the branch name with
@your-github-username/
.) - Run
yarn
in the root directory to generate the build files. - Use conventional commits including in the PR title.
- Fill out the entire PR template. Ensure your code is tested locally and has continuous tests in CI.
- Make sure all tests pass on GitHub Actions.
- Wait for a review and adjust the code if necessary.
- Plugins can be generated by running
yarn gen
. - Add plugins to the example in
apps/app
to test them. - The example app should always stay in a state of regeneration.
Be sure to run the following scripts in the root directory to update automation tools:
- Update dependabot:
yarn update-dependabot-config
- Update the issue template:
yarn update-issue-template
All publishing should be handled automatically whenever code is merged to main
.