Your achievements

Level 1

0% to

Level 2

Tip /
Sign in

Sign in to Community

to gain points, level up, and earn exciting badges like the new
Bedrock Mission!

Learn more

View all

Sign in to view all badges

SOLVED

What are your thoughts on using readme files at the component and model level?

Avatar

Level 2

I'm joining a large project that is in the process of updating components and templates to 6.5. Its been difficult to tell what has and hasn't been updated without reviewing the code of each file.

 

My thoughts are to start documenting each component with a readme as its updated. Each would have whats completed, whats remaining, and any additional notes that may be important to the update process. Like listing any dependencies or bugs that need to be addressed before it can be completed. It may not be as helpful at the sling model package level but using javadocs and todos would be a good way to track the process.

 

This feels like it would be helpful for current and future devs. What are your thoughts on doing this?

1 Accepted Solution

Avatar

Correct answer by
Level 10

Hi @Art_Broussard ,
Definitely it will be a good practice to add a README.md file for each component and provide the details there. Along with this you should also keep comments/javadocs which explain each method/class/variable etc in order to make the code readable. 

Below reference to understand how to create/utilize readme file:

https://medium.com/ida-mediafoundry/aem-tech-component-documentation-97c833a9cda0

 

View solution in original post

1 Reply

Avatar

Correct answer by
Level 10

Hi @Art_Broussard ,
Definitely it will be a good practice to add a README.md file for each component and provide the details there. Along with this you should also keep comments/javadocs which explain each method/class/variable etc in order to make the code readable. 

Below reference to understand how to create/utilize readme file:

https://medium.com/ida-mediafoundry/aem-tech-component-documentation-97c833a9cda0