search

tailwindlabs / tailwindui-issues

Bug fixes and feature request tracking for Tailwind UI.
233 stars 4 forks source link

Catalyst: add .git directory to artifacts #1605

Closed dokkodo101 closed 2 months ago

dokkodo101 commented 2 months ago

Thanks for adding changelog.md to catalyst template. That's really helpful.

Can you also add versioning using commit and include the .git directory in artifacts file?

Right now I have my own private repository to keep track of changes. I use it so that I can exactly know the changes made to core components. I cannot copy and paste the component directory into my own projects since I've made adjustments to the components. But at the same time I do not want to lose the enhancements made in upstream hence tracking of diffs and applying the same changes onto my own fork.

Having .git directory included in the zipped artifact file should help others as it helps me.

Hope this makes sense. Thanks!

adamwathan commented 2 months ago

Hey! This is something we've considered but haven't committed to yet because our actual Git history isn't always a clean perfect-commit-after-perfect commit trail, and it's nice to be able not worry about the Git history being part of the actual product.

What we've chosen to do instead is maintain a CHANGELOG.md file in the zip file which includes any changes and links to the appropriate issues that were fixed, where we always explain the change we made as a comment in the thread.

Appreciate the feedback, hopefully this is helpful as a start at least 👍