diff --git a/docs/development/getting-started.md b/docs/development/getting-started.md index 8745825ab..9b2249653 100644 --- a/docs/development/getting-started.md +++ b/docs/development/getting-started.md @@ -27,13 +27,13 @@ base_requirements.txt contrib docs mkdocs.yml NOTICE requ CHANGELOG.md CONTRIBUTING.md LICENSE.txt netbox README.md scripts ``` -The NetBox project utilizes three long-term branches: +The NetBox project utilizes three persistent git branches to track work: * `master` - Serves as a snapshot of the current stable release * `develop` - All development on the upcoming stable release occurs here -* `develop-x.y` - Tracks work on an upcoming major release +* `feature` - Tracks work on an upcoming major release -Typically, you'll base pull requests off of the `develop` branch, or off of `develop-x.y` if you're working on a new major release. **Never** base pull requests off of the master branch, which receives merged only from the `develop` branch. +Typically, you'll base pull requests off of the `develop` branch, or off of `feature` if you're working on a new major release. **Never** merge pull requests into the `master` branch, which receives merged only from the `develop` branch. ### Enable Pre-Commit Hooks diff --git a/docs/development/release-checklist.md b/docs/development/release-checklist.md index 22fa6f1e8..f3338ffd3 100644 --- a/docs/development/release-checklist.md +++ b/docs/development/release-checklist.md @@ -52,10 +52,7 @@ Close the release milestone on GitHub after ensuring there are no remaining open ### Merge the Release Branch -Submit a pull request to merge the release branch `develop-x.y` into the `develop` branch in preparation for its releases. - -!!! warning - No further releases for the current major version can be published once this pull request is merged. +Submit a pull request to merge the `feature` branch into the `develop` branch in preparation for its release. --- diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index 39189bbd1..9745df1f3 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -83,7 +83,7 @@ Checking connectivity... done. ``` !!! note - Installation via git also allows you to easily try out development versions of NetBox. The `develop` branch contains all work underway for the next minor release, and the `develop-x.y` branch (if present) tracks progress on the next major release. + Installation via git also allows you to easily try out development versions of NetBox. The `develop` branch contains all work underway for the next minor release, and the `feature` branch tracks progress on the next major release. ## Create the NetBox System User