Improved developer docs (#19)

Author: tobiasge

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -32,7 +32,7 @@ body:
   - type: textarea
     attributes:
       label: Example YAML
-      description: Provide an example for the YAML file that is causing you issue
+      description: Provide an example for the YAML file that is causing your issue
       placeholder: |
         ---
       render: YAML

docs/dev/Branches.md

@@ -0,0 +1,10 @@
+# Git branching model
+
+## `main` branch
+
+All new features and bugfixes will first be merged into the main branch. The `Major.Minor` version number will follow those from Netbox with which the plugin is compatible.
+
+## `netbox/vX.Y` branches
+
+After a new Netbox release is published the state of the main branch is copied into a new `netbox/vX.Y` branch. For example after the release of Netbox 3.4 the `main` branch will be copied to `netbox/v3.3`. Only after that copy is made changes for Netbox 3.4 can be merged into `main`.
+These branches are in maintenance mode. No new feature will be merged but bugfixes can be backported from `main` if they are relevant.

Release.md docs/dev/Release.mdRelease.md renamed to docs/dev/Release.md

@@ -1,22 +1,26 @@
-# Prepare a release
+# Release management
+
+The version numbers will follow those of Netbox. A given release of netbox-initializers is only compatible with a Netbox release with a matching `Major.Minor` version. The patch release number will be used for bugfixes in the plugin.
+
+## Prepare a release
 
 Please follow these steps to produce a release
 
-## Checkout correct branch
+### Checkout correct branch
 
 Checkout the branch for which the release is to be build. If no branch exists for the new release one must be created. The name must correspond to the Netbox version in the format "netbox/MAJOR.MINOR".
 
-## Set version number
+### Set version number
 
 For patch releases the version number in `pyproject.toml` and the `NetBoxInitializersConfig` needs to be updated. If the release is for a new Netbox version additional changes need to be made in `README.md` and `Dockerfile` (for tests).
 
-## Build the release automatically
+### Build the release automatically
 
 After changing the version numbers and committing them create a new release with the GitHub Web UI. Configure the release to create a new tag with the name `vX.Y.Z`.
 
-## Build the release manually
+### Build the release manually
 
-### Build the packages
+#### Build the packages
 
 Install the needed Python packages for the build:
 
@@ -30,7 +34,7 @@ Then run the build for the wheel and source distributions:
 poetry build
 ```
 
-### Upload packages to PyPi
+#### Upload packages to PyPi
 
 ```bash
 poetry publish