docs(readme): update readme file #5092
Conversation
README.md
Outdated
| - [master](https://github.com/ReactiveX/rxjs/commits/master) - This is all of the current, unreleased work, which is against v7 of RxJS right now | ||
| - [stable](https://github.com/ReactiveX/rxjs/tree/6.x) - This is the branch for the latest version you'd get if you do `npm install rxjs` | ||
|
|
||
| Most PRs should be made to **master**, unless you know it is a breaking change. |
There was a problem hiding this comment.
I think we can remove the "unless you know it is a breaking change".
TBH, that makes no sense to me: there are two branches listed here and this implies that if the submitter knows it's a breaking change it should target ... stable? 🤷♂
IMO, it should just say "Most PRs should be made to master."
My understanding is that we change the branch to which master refers to manage this. E.g. until fairly recently, master was the 6.x branch, but now that the version 7 release is imminent, we want PRs to target version 7, so that's the master branch. Contributors should almost always target master because we configure master to be the branch to which PRs should be targeted.
There was a problem hiding this comment.
Makes sense. Just made the change :)
Update the main readme file
dzhavat
force-pushed
the
readme-update
branch
from
5253c41
to
2e4c912
Compare
Update the main readme file
Description:
Since there's no
stablebranch, I thought using the6.xwill be more correct.And I've also copied a line from
5.xbranch about making PRs. I've seen at least one person asking for this in a comment. Another option could be adding that line to the PR template.Related issue (if exists):