Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update feature branch docs #742

Merged
merged 1 commit into from
Nov 13, 2023
Merged

Update feature branch docs #742

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions documentation/git.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down