search

Faire / mjml-react

React component library to generate the HTML emails on the fly
https://www.npmjs.com/package/@faire/mjml-react
MIT License
387 stars 17 forks source link

Update render import in readme #65

Closed emmclaughlin closed 1 year ago

emmclaughlin commented 1 year ago

Addresses #64 - Update how the render function is imported in the README.md

We moved the render method out of the root index file because it requires additional dependencies that package users may not want to install. We encourage users to create their own render method that suits their own needs, but maintain this one as a utility function if users are just looking for a quick implementation.

IanEdington commented 1 year ago

@hchiufaire I think this PR title doesn't match semantic-release's expectation.

  1. Is there a way to lint for this?
  2. Should we implement https://github.com/commitizen/cz-cli to help contributors
emmclaughlin commented 1 year ago

@hchiufaire I think this PR title doesn't match semantic-release's expectation.

  1. Is there a way to lint for this?
  2. Should we implement https://github.com/commitizen/cz-cli to help contributors

It doesn't but is this something we want to include in semantic-release if it is just a README change and doesn't affect the shipped package?

IanEdington commented 1 year ago

It doesn't but is this something we want to include in semantic-release if it is just a README change and doesn't affect the shipped package?

I believe there's one called chore that doesn't get added to the changelog