Skip to content

Contributing

Matthew Whitaker edited this page May 31, 2023 · 2 revisions

Thanks for your interest in contributing to flutter_html!

Please adhere to the following guidelines when contributing:

Pull Request Guidelines

  1. For new features, please don't submit a pull request without discussing the feature with me in an issue first. I don't want you to have to do a whole bunch of work for nothing if the feature isn't one we plan on supporting.
  2. For bug fixes, please reference the issue where the bug is described. If it doesn't exist, please create one before filing the pull request.
  3. Please read through the wiki before contributing. This ensures you have a solid understanding of how the package works.

New Extension Guidelines

flutter_html strives to be as lightweight as possible, while maintaining a select few official extension packages (e.g. flutter_html_svg, etc.). We may occasionally adopt additional official extensions. Here are the requirements any official extension will need to meet in order to be considered for adoption:

  1. Does the extension add functionality supported by major browsers today, but not supported by flutter_html? If no, consider releasing as a third-party extension package.
  2. Does the extension depend on a third-party package? If no, consider adding to the core flutter_html library as a built-in HtmlExtension.
  3. Is the extension generally helpful and useable? If no, consider releasing as a third-party extension package.
  4. Is the extension of high quality? If no, consider adding tests and documentation to improve the quality of the package.
Clone this wiki locally