Skip to content
This repository was archived by the owner on Oct 1, 2018. It is now read-only.

Conversation

@knitcodemonkey
Copy link
Contributor

@knitcodemonkey knitcodemonkey commented Oct 18, 2017

  • Update README.md to be more descriptive.
  • Add CONTRIBUTING.md along the same guidelines as RxJs CONTRIBUTING.md
  • Add commitizen, cz-conventional-changelog to dev dependencies
  • Add commizen config to package.json to reference cz-conventional-changelog
  • Add commit script to package.json to run commitizen as is used by the RxJs repo

No breaking changes. Assists in closing #19

Jennifer Luker added 10 commits October 18, 2017 13:58
Mimic the RxJs commit wizard for use with rxjs-docs. The rxjs-github-bot requires a certain format
for git messages. The commitizen and cs-conventional-changelog modules help make that a breeze.

No breaking changes. Just an added feature.
add reference to code of conduct and new contributing file

none
…t currently exist

docs have not been installed as of yet, so I removed the copied reference to them

none
Adding same license to rxjs-docs as exists in RxJs

none
Change badge links from rxjs to rxjs-docs

none
Add ability for readme.md to identify npm usage

none
…info

Add goals, building/testing scripts information, and commit message info

none
Title referenced RxJs. Change to RxJs Docs

none
@rxjs-bot
Copy link

Warnings
⚠️

❗ Big PR (1)

⚠️

commit message does not follows conventional change log (2)

(1) : Pull Request size seems relatively large. If Pull Request contains multiple changes, split each into separate PR will helps faster, easier review.

(2) : RxJS uses conventional change log to generate changelog automatically. It seems some of commit messages are not following those, please check contributing guideline and update commit messages.

Generated by 🚫 dangerJS

@ladyleet
Copy link
Member

LGTM @knittingcodemonkey! thanks for your 2nd contribution! @kwonoj 👍?

is necessary because release notes are automatically generated from these messages.

```shell
git commit -a
Copy link
Member

Choose a reason for hiding this comment

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

not for this PR, but probably we should have same tooling as rxjs repo to support npm run commit commit wizard.

Copy link
Member

Choose a reason for hiding this comment

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

welp, actually this PR has it - let's add into guides as well (and recommend to use it)

@ladyleet ladyleet merged commit aec9e36 into ReactiveX:master Oct 18, 2017
@kwonoj
Copy link
Member

kwonoj commented Oct 18, 2017

Super nitty comment otherwise lgtm. I'd recommdnd ppl use npm run commit daily instead of direct commit.

@ladyleet
Copy link
Member

Felt so good to merge this! Thx @knittingcodemonkey!

@knitcodemonkey knitcodemonkey deleted the addToReadme branch October 18, 2017 21:41
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants