-
Notifications
You must be signed in to change notification settings - Fork 2
Add the default README template #17
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
base: master
Are you sure you want to change the base?
Conversation
Following the final draft over at: https://bitbucket.org/ramsalt/readme-template/src
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Encoding issue must be updated for sure, the rest you can check. :)
@esolitos fixed the change requests |
The README should also be added to the |
@esolitos the requested changes are applied, we shall merge |
No, you should include it in the scaffolding info, see (here as example)[https://github.com/ramsalt/drupal-scaffold/blob/master/composer.json#L14]. The issue here is that we do not want to replace the |
@esolitos added the file mapping for the README, is that the correct way of handling this? |
@@ -12,6 +12,7 @@ | |||
"drupal-scaffold": { | |||
"file-mapping": { | |||
"[project-root]/wodby.yml": "assets/wodby.yml", | |||
"[project-root]/README.md": "assets/README.md", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would overwrite the README every time drupal:scaffold runs. That needs to be prevented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@doxigo Have you seen this feedback?
Following the final draft over at readme-template we can add a starter README file to all projects