Update README.md to include Packwerk Retrospective article #389
Conversation
Sid Sijbrandij sends his regards.
| @@ -85,6 +85,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Shopif | |||
|
|
|||
| Read and follow the guidelines in [CONTRIBUTING.md](https://github.com/Shopify/packwerk/blob/main/CONTRIBUTING.md). | |||
|
|
|||
| ## Related Documentation | |||
There was a problem hiding this comment.
| ## Related Documentation | |
| ## Learn More |
| @@ -85,6 +85,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Shopif | |||
|
|
|||
| Read and follow the guidelines in [CONTRIBUTING.md](https://github.com/Shopify/packwerk/blob/main/CONTRIBUTING.md). | |||
|
|
|||
| ## Related Documentation | |||
|
|
|||
| [A Packwerk Retrospective](https://shopify.engineering/a-packwerk-retrospective) by Gannon McGibbon - 12 min read | |||
There was a problem hiding this comment.
| [A Packwerk Retrospective](https://shopify.engineering/a-packwerk-retrospective) by Gannon McGibbon - 12 min read | |
| [A Packwerk Retrospective](https://railsatscale.com/2024-01-26-a-packwerk-retrospective/) by Gannon McGibbon and Chris Salzberg |
|
Happy to contribute @gmcgibbon (Also Sid asked me to 🙂). Can you help me understand how to sign the CLA for you? : |
|
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? 🤷🏼 |
|
@caffeinefriend If you click on the details for the CLA check failure it tells you how to sign. |
|
CLA signed ✅ |
|
I have signed the CLA! |
|
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. |
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