From b4aaf6c9fe9f0eb88bea52956bff3e4a2b6750e3 Mon Sep 17 00:00:00 2001 From: Aram <37216945+alimpens@users.noreply.github.com> Date: Mon, 13 Nov 2023 14:45:49 +0100 Subject: [PATCH] Update feature branch docs (#742) --- documentation/git.md | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/documentation/git.md b/documentation/git.md index dae0469a51..fd83d53129 100644 --- a/documentation/git.md +++ b/documentation/git.md @@ -32,7 +32,10 @@ We work with small, short-lived branches (aim for 2 working days) directly on a The approach is called ‘[trunk-based development](https://trunkbaseddevelopment.com/)’ and differs from the well-known ‘Git Flow’. -Branches are automatically deployed to their own environment. To get the address of a branch deployment, go to the repository on GitHub.com and click on [Deployments](https://github.com/Amsterdam/design-system/deployments). Find the branch in the list and click on the external website icon. +Branches are automatically deployed to their own environment. There are 2 ways to get the address of a branch deployment: + +- If the branch has a pull request, you can find the address there using the 'View deployment'-button. You might need to click 'Show environments' to see this button. +- Otherwise, go to the repository on GitHub.com and click on [Deployments](https://github.com/Amsterdam/design-system/deployments). Find the branch in the list and click on the external website icon. ## Create a branch @@ -74,19 +77,6 @@ All together, good branch names look like this: - `refactor/DES-368-use-singular-for-enums` - `task/DES-104-add-initial-git-guidelines` -### Forbidden branch names - -There are a couple of forbidden branch names, owing to the way we have currently set up feature branch deployments. - -These are: - -- `assets` -- `sb-addons` -- `sb-common-assets` -- `sb-manager` -- `sb-preview` -- `storybook-react` - ## Describe each commit Take some time to determine a good description for your commit. Try to describe the goal of the change. Don’t describe what also be deduced from the diff.