Skip to content

Add the default README template#17

Open
doxigo wants to merge 3 commits into
masterfrom
doxigo-patch-1
Open

Add the default README template#17
doxigo wants to merge 3 commits into
masterfrom
doxigo-patch-1

Conversation

@doxigo

@doxigo doxigo commented Jul 13, 2021

Copy link
Copy Markdown
Contributor

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

@esolitos esolitos left a comment

Copy link
Copy Markdown

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. :)

Comment thread assets/README.md Outdated
Comment thread assets/README.md Outdated
Comment thread assets/README.md Outdated
@doxigo

doxigo commented Aug 17, 2021

Copy link
Copy Markdown
Contributor Author

@esolitos fixed the change requests

@esolitos

esolitos commented Sep 3, 2021

Copy link
Copy Markdown

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

@doxigo

doxigo commented Sep 4, 2021

Copy link
Copy Markdown
Contributor Author

@esolitos the requested changes are applied, we shall merge

@esolitos

esolitos commented Sep 7, 2021

Copy link
Copy Markdown

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

doxigo commented Sep 14, 2021

Copy link
Copy Markdown
Contributor Author

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

@doxigo

doxigo commented Feb 11, 2022

Copy link
Copy Markdown
Contributor Author

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

Comment thread composer.json
"drupal-scaffold": {
"file-mapping": {
"[project-root]/wodby.yml": "assets/wodby.yml",
"[project-root]/README.md": "assets/README.md",

Copy link
Copy Markdown
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
Copy Markdown
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