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.

Sign up for GitHub

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

Jump to bottom

feat: generate a README.md file when creating a new library #13296

Closed
klauskpm opened this issue Dec 25, 2018 · 4 comments · Fixed by #13331
Closed

feat: generate a README.md file when creating a new library #13296

klauskpm opened this issue Dec 25, 2018 · 4 comments · Fixed by #13331
Labels
devkit/build-angular:library feature Issue that requests a new feature help wanted
Milestone
Backlog

Comments

@klauskpm
Copy link
Contributor

Bug Report or Feature Request (mark with an x)

- [ ] bug report -> please search issues before submitting
- [x] feature request

Command (mark with an x)

- [ ] new
- [ ] build
- [ ] serve
- [ ] test
- [ ] e2e
- [x] generate
- [ ] add
- [ ] update
- [ ] lint
- [ ] xi18n
- [ ] run
- [ ] config
- [ ] help
- [ ] version
- [ ] doc

Desired functionality

Generate a default README.md file when creating a new library. I think it's more common to have a README.md file on a NPM package than not.

I'd be happy to work on it o/
@klauskpm klauskpm changed the title feat: generate README.md file when creating a new library feat: generate a README.md file when creating a new library Dec 25, 2018
@ngbot ngbot bot added this to the Backlog milestone Dec 25, 2018
@alan-agius4
Copy link
Collaborator

Good idea.

@klauskpm
Copy link
Contributor Author

klauskpm commented Dec 27, 2018 •
edited

Hey @alan-agius4 , I made the tests work, but, when I run the CLI (ng g lib), after linking it, it didn't create the file. Could you help me on this?

What was done?

Here is the forked repository's commit diff (README.md content is just for testing purposes).

I tried to follow the Development Hints for working on Angular CLI, but the linked package didn't present any changes that I've made.
I've even deleted everything from /packages/schematics/angular/library/files/__projectRoot__ and built it, but the result was the same, no changes on ng g lib.

Am I changing the right place?

@klauskpm
Copy link
Contributor Author

Just an update. npm pack worked for me.

@klauskpm klauskpm mentioned this issue Dec 29, 2018
Merged
alexeagle pushed a commit that referenced this issue Jan 8, 2019
@klauskpm @alexeagle
feat(@schematics/angular): generate a library with a README.md file
100cf47 
Fixes #13296
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
devkit/build-angular:library feature Issue that requests a new feature help wanted
Projects
None yet
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

feat(@schematics/angular): generate a library with a README.md file
2 participants
@klauskpm @alan-agius4