Closed samuelmeuli closed 4 years ago
While you are working on it, Can you also fix text in Contributing.md
.
I think it was copied from the Core components project and has a left-over :
We strongly encourage users of the Core Components to bring their own project experience to these issues, as there may be alternative use-cases or requirements that haven't yet been considered.
It should be removed.
If you see this page - https://github.com/samuelmeuli/aem-spa-project-archetype/tree/readmes/src/main/resources/archetype-resources
You see stuff like -
#set($hash = '#') ${hash} AEM SPA Project
${hash}${hash} Modules
I don't think that's intended, right ? If not, can you fix it ?
While you are working on it, Can you also fix text in Contributing.md.
Ok, I'll update that.
I don't think that's intended, right ?
It is intended. #
seems to be a reserved character with Maven, and the README
files get corrupted if we don't do this. This is the same approach as in aem-project-archetype
.
Also, aem-project-archetype
doesn't have a CHANGELOG.md
file, but has that information in the Releases tab. We're currently doing both. Would you be okay with following the same approach and removing the file?
Improved the README files throughout the project:
angular-app
/react-app
directories