Skip to content

Commit eced266

Browse files
authored
Fix documentation
1 parent 12a6f9a commit eced266

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,15 @@
2121

2222
## How to start development
2323

24-
This plugin does not include build assets and PHP-dependencies. Therefore, after loading that repository via Composer or git checkout you have to install them.
24+
> [!NOTE]
25+
> The `master` branch contains a production-ready plugin with pre-built assets, but development happens on other branches.
2526
26-
**With Yarn:**
27+
For development, clone the repository (which uses the default development branch) and run the build process to generate the required assets and install PHP dependencies before you begin coding:
2728

2829
```shell
29-
yarn install && yarn build
30+
cd google-tag-manager
31+
composer install
32+
npm install && npm run build
3033
```
3134

3235
## Testing & Quality
@@ -47,20 +50,21 @@ vendor/bin/phpunit
4750

4851
## How to create a release
4952

50-
To create a release go to the `<target>-built` branch and create the tag and the release.
53+
To create a release go to the `<target>` branch and create the tag and the release.
5154

5255
**Example 1: A change is going to be added to `master` branch.**
5356

54-
A developer makes a PR to `master` branch adding a feature.
55-
Once it gets merged a build & push workflow will be triggered.
56-
[bot] This workflow will create a build and push it to `master-built` branch.
57-
[human] Then create a tag on `master-built` and then a release.
57+
- A developer makes a PR to `dev/master` branch adding a feature.
58+
- Once it gets merged, a maintainer triggers the `Build and distribute` workflow providing the version number to be released.
59+
- [bot] This workflow will create a build and push it to `master` branch.
60+
- [human] Then create a tag on `master` and then a release.
5861

5962
**Example 2: A change is going to be added to `1.x` branch.**
60-
A developer makes a PR to `1.x` branch adding a feature.
61-
Once it gets merged a build & push workflow will be triggered.
62-
[bot] This workflow will create a build and push it to `1.x-built` branch.
63-
[human] Then create a tag on `1.x-built` and then a release.
63+
64+
- A developer makes a PR to `dev/1.x` branch adding a feature.
65+
- Once it gets merged, a maintainer triggers the `Build and distribute` workflow providing the version number to be released.
66+
- [bot] This workflow will create a build and push it to `1.x` branch.
67+
- [human] Then create a tag on `1.x` and then a release.
6468

6569
## Copyright and License
6670

0 commit comments

Comments
 (0)