-
Notifications
You must be signed in to change notification settings - Fork 567
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ Request]Add more code comments to wknd #298
Comments
hey @Rappa-Adobe is there a specific area that needs more comments? i.e ImageList component? |
@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. |
@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" |
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. |
yup makes sense @Rappa-Adobe. Also Sightly got rebranded to HTL! ;) |
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! |
Expected Behaviour
This is a suggestion to add more comments to the code for wknd.
The text was updated successfully, but these errors were encountered: