Skip to content
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

Open
Rappa-Adobe opened this issue Nov 17, 2021 · 6 comments
Open

[ Request]Add more code comments to wknd #298

Rappa-Adobe opened this issue Nov 17, 2021 · 6 comments
Labels
enhancement New feature or request

Comments

@Rappa-Adobe
Copy link

Expected Behaviour

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

@godanny86
Copy link
Contributor

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

@godanny86 godanny86 added the enhancement New feature or request label Nov 17, 2021
@Rappa-Adobe
Copy link
Author

@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
Copy link
Contributor

@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
Copy link
Author

@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
Copy link
Contributor

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

@godanny86
Copy link
Contributor

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants