search

adobe / aem-guides-wknd

Tutorial Code companion for Getting Started Developing with AEM Sites WKND Tutorial
https://experienceleague.adobe.com/docs/experience-manager-learn/getting-started-wknd-tutorial-develop/overview.html
MIT License
287 stars 565 forks source link

[ Request]Add more code comments to wknd #298

Open Rappa-Adobe opened 2 years ago

Rappa-Adobe commented 2 years ago

Expected Behaviour

This is a suggestion to add more comments to the code for wknd.

godanny86 commented 2 years ago

hey @Rappa-Adobe is there a specific area that needs more comments? i.e ImageList component?

Rappa-Adobe commented 2 years ago

@godanny86 Sorry, It is a vague answer but since wknd is used for reference comments throughout would be helpful. It might make sense to add as code is updated instead of doing it all at once.

davidjgonzalez commented 2 years ago

@Rappa-Adobe so you'd like to see comments added to pretty much everything explaining the key "jobs" its doing and any important considerations/decisions points, from Java code, to JavaScript, to CSS, Node definition, etc.

As you mentioned this might be more of go-forward motion as code is updated and/or new code is added - almost like a definition-of-done for a PR .. "Is it well commented? Yes/No"

Rappa-Adobe commented 2 years ago

@davidjgonzalez

I think that makes sense, to do it going forward. Some areas where it might be most helpful for example are in the tutorial branches. Also things like sightly which is more specific to AEM.

godanny86 commented 2 years ago

yup makes sense @Rappa-Adobe. Also Sightly got rebranded to HTL! ;)

godanny86 commented 2 years ago

we need to re-do the tutorial branches to get on the latest archetype, so might be able to sneak in a few more comments as we go. Glad that its being used!