Skip to content
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

Add default readme for generated project #393

Merged
merged 2 commits into from
Jun 24, 2021
Merged

Conversation

khattakdev
Copy link
Contributor

Closes #362

This PR took me a whole day to debug. There is something wrong with tests, maybe with a specific npm package.
When adding a README.md template in app and app-ts like following

# Getting Started with Fastify-CLI

This project was bootstrapped with [Fastify-CLI](https://github.com/fastify/fastify-cli).

This results in the failure of test suitss. A workaround for this is to add content like the following:

# Getting Started with Fastify-CLI

###### This project was bootstrapped with [Fastify-CLI](https://github.com/fastify/fastify-cli).

Checklist

@mcollina
Copy link
Member

The changes looks good but the tests should be fixed

@khattakdev
Copy link
Contributor Author

The changes looks good but the tests should be fixed

This is quite strange. While making this PR, I tested it and it was working fine. Now I realized, it works on fine on windows machine but fails on Unix (tried on WSL2)
Windows:
image
WSL2:
image

I've been working on this since yesterday but couldn't find out what's the exact issue. Any help would be really appreciated.

@khattakdev
Copy link
Contributor Author

With the new commit, this should work fine now. It was failing in package.json (description file). I didn't know it auto copy the first paragraph from README and add it to description

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

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.

Add default readme for generated project
3 participants