Add in cookbook template #1268
Add in cookbook template #1268
Conversation
There was a problem hiding this comment.
This looks fantastic! 🎉 I left a couple small notes, but I think this will give us a great base moving forward. I don't expect that this will serve every possible recipe, but I think that would be impossible. We can continue adapting it and perhaps eventually split it out into several possible templates as the cookbook evolves.
One other note is that we may want to delay the invitation for non-members to contribute recipes for now. Or as you suggested in the Slack, request that they open an issue to discuss it before starting a cookbook recipe. (I know, I'm fickle and changed my mind as I thought about it more. 😅)
|
|
||
| _optional, except when the section above is provided_ | ||
|
|
||
| This section is required when you've provided the section above about avoidance. It's important to explore other methods so that people told that something is an antipattern in certain situations are not left high and dry. In doing so, consider that the web is a big tent and that many people have different codebase structures and are solving different goals. Is the app large or small? Are they integrating Vue into an existing project, or are they building from scratch? Are their users only trying to achieve one goal or many? Is there a lot of asyncronous data? All of these concerns will impact alternative implementations. A good cookbook recipe gives developers this context. |
There was a problem hiding this comment.
I think "left high and dry" might be difficult for non-native speakers to understand. How about "left wondering"?
There was a problem hiding this comment.
Good call! I need to get in this mindset of internationalization
| - Articulate the problem in a sentence or two. | ||
| - Explain the simplest possible solution in a sentence or two. | ||
| - Show a small code sample. | ||
| - Explain what this accomplishes in a sentence. |
There was a problem hiding this comment.
Hm, sometimes I like to include a code example demonstrating the problem before I go into the solution.
Also, maybe these should be numbered to imply that they are all required and should generally be followed in order.
There was a problem hiding this comment.
Hm, what if the flow of how to explain that code in particular doesn't work that way? Perhaps it's possible to do an ol and say that the order is "strongly suggested, but not imperative". Actually imperative has other meanings in code haha, so maybe... "vital".
|
I've updated the PR with some of the suggestions above, as well as some additional improvements:
Happy to update further! Let me know what you think. |
* update sponsor link * update sponsor image * Add in cookbook template (vuejs#1268) * Add in cookbook template * update cookbook template based on review comments
Creating a template for common use and guidelines for contributing to The Cookbook. Most of this is a standardization of the Adding Instance Properties example from @chrisvfritz.
Some things to note, entirely up for debate: