Welcome, and thanks for your interest in Embellish. Whether you're new to web development or are here to teach us new tricks, we're glad to have you and look forward to your contributions. Listed below are a few ways you can help.
If you have a question, please open an issue to discuss it. This might help us to find a defect; reveal an opportunity to improve the documentation or developer experience; or help someone facing a similar issue in the future.
Please open an issue to discuss any defects you find. Include as much detail as you can, and if possible provide a link to a repository or demo environment where the issue can be reproduced.
Please share any suggestions for improving or adding to the documentation by submitting a pull request or opening an issue.
If you have created a tutorial, auxiliary library, interesting code example, or other resource related to Embellish, please share it with the community on X, Facebook, or anywhere you discuss web development topics. Increasing awareness will bring more users (and potential contributors) to the project.
Pull requests are welcome, but we ask that you open an issue to discuss your plans before making any significant investment of your valuable time.
The only strict requirements for developing Embellish are Node.js and PNPM. Review the CI workflow to determine which version you should use.
If you are a VS Code user, please consider installing the recommended extensions for Embellish contributors.
Embellish uses Changesets for versioning and to generate release notes.
Please verify your changes before submitting a pull request using the following commands:
pnpm check, which runs formatting and lint checks;pnpm -r test, which runs the unit tests.
When you are ready to submit a pull request, please make sure to include:
- a brief description of the change;
- a link to the related issue, if applicable;
- any design considerations you feel are important; and
- any ideas you may have to improve upon your submission in the future.