search

laravel-shift / blueprint

A code generation tool for Laravel developers.
MIT License
2.89k stars 275 forks source link

Generate comments to help educate new uses of design choices #65

Open jasonmccreary opened 4 years ago

jasonmccreary commented 4 years ago

Both Laravel and Blueprint follow some documented, as well as community, conventions. Developers new to Laravel may not be familiar with these.

As such, it'd be nice to have a --notes option which would add the Laravel-style block comments with more information about the generated code with links to the documentation where applicable.

With this we can ensure Blueprint users become familiar with Laravel as well as Blueprint, and vice version.

gmgarrison commented 4 years ago

Just popping in to say, as a relatively new Laravel developer, anything that can help devs internalize the Laravel approach seems to have tons of spillover benefits. I would def appreciate this option.

jasonmccreary commented 4 years ago

For sure. This is still on the list. Just trying to manage bugs and a few open issues first. 😅

faustbrian commented 1 year ago

@jasonmccreary are there any specific ones that you think would be a good start?

jasonmccreary commented 1 year ago

Not sure. Been so long now. I'd have to get back into it. Probably something I'll do.

Avnsh1111 commented 7 months ago

Hi @jasonmccreary,

I had the pleasure of attending your enlightening talk at Laracon India, where your insights into Blueprint left a lasting impression on me. Inspired by your vision for the project, I'm eager to contribute and make a meaningful impact.

Could you please provide me with some guidance or a jumpstart to begin contributing to Blueprint? I'm enthusiastic about the opportunity to be part of such an innovative project.

Thank you for your time and for sharing your expertise at Laracon India.

Best regards, Avinash Rathod

whoami15 commented 7 months ago

@Avnsh1111

See Contributing section in the Docs.

jasonmccreary commented 7 months ago

Thanks @Avnsh1111. If you're looking to get involved. I would take a look at the Contributing section, open issues, or simply review the code and see if there are any quick refactors you could do to make your first PR.