Skip to content

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add the default README template #17

wants to merge 3 commits into from

Conversation

doxigo
Copy link
Contributor

@doxigo doxigo commented Jul 13, 2021

Following the final draft over at readme-template we can add a starter README file to all projects

@doxigo doxigo requested review from esolitos, mnlund and szeidler July 13, 2021 08:38
Copy link

@esolitos esolitos left a 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. :)

@doxigo
Copy link
Contributor Author

doxigo commented Aug 17, 2021

@esolitos fixed the change requests

@esolitos
Copy link

esolitos commented Sep 3, 2021

The README should also be added to the composer.json scaffold files.

@doxigo
Copy link
Contributor Author

doxigo commented Sep 4, 2021

@esolitos the requested changes are applied, we shall merge

@esolitos
Copy link

esolitos commented Sep 7, 2021

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 README.md file, however the first time we setup a project it should actually be replaced.. 🤔

@szeidler szeidler assigned szeidler and doxigo and unassigned szeidler Sep 13, 2021
@doxigo
Copy link
Contributor Author

doxigo commented Sep 14, 2021

@esolitos added the file mapping for the README, is that the correct way of handling this?

@doxigo
Copy link
Contributor Author

doxigo commented Feb 11, 2022

@mnlund @szeidler would be nice if you guys could look into this

@@ -12,6 +12,7 @@
"drupal-scaffold": {
"file-mapping": {
"[project-root]/wodby.yml": "assets/wodby.yml",
"[project-root]/README.md": "assets/README.md",
Copy link
Member

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.

Copy link
Member

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?

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

Successfully merging this pull request may close these issues.

3 participants