npm Community Forum (Archive)

The npm community forum has been discontinued.

To discuss usage of npm, visit the GitHub Support Community.

Clarify Merge Target Branch in CONTRIBUTING.md

Hi,

this doesn’t quite fit the bug template but I wasn’t sure how to submit a request for a documentation update.

I would like to submit a PR on npm and read the CONTRIBUTING.md file, but it wasn’t clear to me what target branch to use. Conventionally, I would use master, but I saw several merge target were latest or release-next. Could you please clarify in the document which branch to use?

Thank you!


The #support:docs-needed category would be good for that (I went ahead and changed it).

I can’t find official sources at the moment, but most (non-staff) PRs are merged with release-next. The main branch is called latest (instead of master) isn’t (AFAIK) committed to directly but mostly consists of updates from release-next.


Thank you very much for updating the category, Lars. I admit I am still a bit new to the “newer” way of bug and issue tracking (still used to the old GitHub issues).

I ended up submitting my PR to release-next. Maybe the documentation will be updated. I don’t mind doing a PR for that, too, so long as what you stated would be correct.


Thanks for pointing this out, release-next is the correct branch to target. latest is where one of the CLI team members will merge everything at the end. We’ve been working on updating our process docs so I’ll poke around and see where this can be updated.


I set latest as the default because release-next used to be a moving target, and it would result in people’s PRs having to be rebased to show what the actual patches were. latest provided a stable target and I was switching it to release-next before doing actual integration.

Since we started doing proper prerelease tags, though, release-next is much more stable and I think safe to set as the default PR target again. It’ll catch a lot of errors on my part, too, since I’ve accidentally merged to latest a number of times before.