Skip to content

Commit 013818b

Browse files
committed
Update CONTRIBUTING to better reflect current branch strategy
This commit clarifies that both new features and bug fixes should be submitted to the "develop" branch initially, with changes moving from "develop" to "master" only when it is time for a new release. It also clarifies that pull requests should always be done against the "develop" branch.
1 parent 3a11339 commit 013818b

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

CONTRIBUTING.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,18 @@ contributors list.
6868
Branches
6969
--------
7070

71-
There are two long-lived branches in AsyncSSH at the moment:
71+
There are two long-lived branches in AsyncSSH:
7272

7373
* The master branch is intended to contain the latest stable version
7474
of the code. All official versions of AsyncSSH are released from
7575
this branch, and each release has a corresponding tag added
76-
matching its release number. Bug fixes and simple improvements
77-
may be checked directly into this branch, but most new features
78-
will be added to the develop branch first.
79-
80-
* The develop branch is intended to contain features for developers
81-
to test before they are ready to be added to an official release.
82-
APIs in the develop branch may be subject to change until they
83-
are migrated back to master, and there's no guarantee of backward
76+
matching its release number.
77+
78+
* The develop branch is intended to contain new features and bug fixes
79+
ready to be tested before being added to an official release. APIs
80+
in the develop branch may be subject to change until they are
81+
migrated back to master, and there's no guarantee of backward
8482
compatibility in this branch. However, pulling from this branch
8583
will provide early access to new functionality and a chance to
86-
influence this functionality before it is released.
84+
influence this functionality before it is released. Also, all
85+
pull requests should be submitted against this branch.

0 commit comments

Comments
 (0)