docs(README): improve related modules section #427
Conversation
|
We haven't done too much on the docs after we put all modules into this monorepo. I think there's a lot of opportunities to clean it up. |
| ## About this Repo | ||
|
|
||
| The conventional-changelog repo is managed as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md); it's composed of many npm packages. | ||
|
|
||
| The original `conventional-changelog/conventional-changelog` API repo can be | ||
| found in [packages/conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog). | ||
|
|
||
| ## Getting started |
There was a problem hiding this comment.
If someone lands on this GitHub repository, would they be more interested in how we organize our repository (Discussed in the About this Repo section above), or how to use conventional changelogs?
If the latter, can this section be moved up in the README?
There was a problem hiding this comment.
I agree, I think we should move it up
|
|
||
| It's recommended you use the high level [standard-version](https://github.com/conventional-changelog/standard-version) library, which is a drop-in replacement for npm's `version` command, handling automated version bumping, tagging and CHANGELOG generation. | ||
|
|
||
| Alternatively, if you'd like to move towards completely automating your release process as an output from CI/CD, consider using [semantic-release](https://github.com/semantic-release/semantic-release). |
There was a problem hiding this comment.
Forgot, can we also reference Lerna for mono-repository project developers?
There was a problem hiding this comment.
Good call @hutson, I think this would be another good library to call out; @evocateur perhaps you could share a blurb you'd like us to use?
|
@stevemao perhaps rebase and we can land this? I agree it would be good to add lerna, but it doesn't need to block this -- @evocateur can add some copy in a bit and we can land it. |
|
@stevemao this has been sitting around for a while, so went ahead and landed it 👍 let me know if I messed anything up in the merge. |
No description provided.