Shopify / packwerk

Good things come in small packages.
MIT License
1.54k stars 111 forks source link

Update README.md to include Packwerk Retrospective article #389

Closed caffeinefriend closed 2 months ago

caffeinefriend commented 4 months ago

Sid Sijbrandij sends his regards.

What are you trying to accomplish?

Adding a link to the README - https://shopify.engineering/a-packwerk-retrospective

What approach did you choose and why?

Concise

What should reviewers focus on?

Would you like this link to live in a new section called 'Related Documentation'? That made the most sense to me. :)

Type of Change

Additional Release Notes

Include any notes here to include in the release description. For example, if you selected "breaking change" above, leave notes on how users can transition to this version.

If no additional notes are necessary, delete this section or leave it unchanged.

Checklist

caffeinefriend commented 4 months ago

Happy to contribute @gmcgibbon (Also Sid asked me to 🙂).

Can you help me understand how to sign the CLA for you? : https://github.com/Shopify/packwerk/blob/main/.github/workflows/cla.yml

exterm commented 4 months ago

mmmh, should this section then include all shopify-published material related to packwerk?

https://shopify.engineering/enforcing-modularity-rails-apps-packwerk for example?

If this is about background information, it probably then should also include the two blog posts on Componentization?

🤷🏼

gmcgibbon commented 4 months ago

@caffeinefriend If you click on the details for the CLA check failure it tells you how to sign.

caffeinefriend commented 4 months ago

CLA signed ✅

caffeinefriend commented 4 months ago

I have signed the CLA!

rafaelfranca commented 2 months ago

Thank you for the pull request. I don't think we need to link to external article in the README. Those articles get old and change and might no reflect what the tooling is anymore.