/simplecov-tailwindcss

Simplecov Output of HTML using Tailwind UX design

Primary LanguageHTMLMIT LicenseMIT

Simplecov Tailwind

GitHub GitHub Workflow Tests Status GitHub Workflow Builds Status GitHub Workflow Lints Status CodeQL GitHub tag (latest by date) Gem Discord

Note: To learn more about SimpleCov, check out the main repo at https://github.com/colszowka/simplecov

Generates a HTML Tailwind Design report generated from Simplecov using ruby 2.5 or greater.

Installation and Usage

Checkout the Documentation for full details.

Change Log

Check out the Change Log for new breaking changes/features/bug fixes per release of a new version.

Contributing

Bug Reports, Feature Requests, and Pull Requests are welcome on GitHub at https://github.com/chiefpansancolt/simplecov-tailwindcss. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

To see more about Contributing check out this document.

  • Fork Repo and create new branch
  • Once all is changed and committed create a pull request.

Ensure all merge conflicts are fixed and CI is passing.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run pnpm test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

When working with CSS or JS ensure to run pnpm build to compile tailwind and JS to the public folder. This will ensure you have the latest CSS and JS used when testing locally.

NOTE: Do not commit any changes made in public folder from compiling as this will be performed by the owner before building of a release.

To test locally run pnpm test and a webpage will open after tests are complete and you will be able to see the page.

To install this gem onto your local machine, run pnpm gem:build. Gems will be built/release by Owner.

License

Simplecov Tailwind is available as open source under the terms of the MIT License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Christopher Pezza

💻 📖 🔧 ⚠️ 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!