Contributing: master vs not master branch about rax HOT 4 CLOSED

Thanks for your advice. We'll fix it ASAP.

from rax.

• Modify the guidelines as:

  The master branch is release branch. All development should be done in dedicated branches. Do not submit PRs against the master branch.
  Checkout a topic branch from master branch, and merge back against master branch. Checkout a topic branch from the relevant branch, e.g. dev, and merge back against that branch

• Publish tag like v0.0.1 when release version

Is this OK? @timoxley

cc @yuanyan

from rax.

Publish tag like v0.0.1 when release version

Sounds good to me.

Your guidelines changes also sound good.

The master branch is release branch.

I interpreted this to mean master only contains code that has "already been" released, rather than "going to be" released. Past releases v.s. future releases. Someone else might interpret it differently however, it's pretty subtle.

Perhaps something like this is more explicit:

Only code that's ready for release should be committed to the master branch.

I'd add the word new into the following:

Checkout a new topic branch from master branch, and merge back against master branch.

I'd also delete the following, if you weren't going to already:

The master branch is basically just a snapshot of the latest stable release

This makes it sound like master will only ever contain the code for the most recent (past) release.

from rax.

@timoxley I have update the guidelines and new release workflow will apply from now. If you don't have another advice I will close this issue. Thanks again!

from rax.