Skip to content

Commit 429b7cd

Browse files
committed
Add close branch info
1 parent 9d78660 commit 429b7cd

File tree

1 file changed

+48
-0
lines changed
  • docs/testing-deployment-publishing/branching-collaboration

1 file changed

+48
-0
lines changed

docs/testing-deployment-publishing/branching-collaboration/branching.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,3 +314,51 @@ To configure these permissions, navigate to **Settings & Integrations > Project
314314
- **Editors** assigned to a branch have the authority to make direct modifications to the project while working within that branch.
315315
- **Mergers** on the other hand, are only allowed to merge other branches into that branch. This is especially useful for protected branches where you don't want any users to make direct modifications. Instead, users should only merge other branches into that branch.
316316

317+
## Closing Branch
318+
319+
Closing a branch is a common practice after the branch has served its purpose, typically once its changes have been merged into another branch (like the `main` or `development` branch). By regularly closing inactive or merged branches, you help maintain a clean, efficient, and well-organized project.
320+
321+
### When to Close a Branch
322+
323+
- **After a Merge:** Once the branch’s changes have been merged into the `main` branch (or another target branch), it’s safe to close the branch. This often happens after a feature is complete or a bug is fixed.
324+
- **Unused Branch:** If a branch is no longer needed (e.g., a feature was abandoned or changes were made in another branch), it’s a good idea to close it.
325+
326+
:::warning
327+
328+
Once a branch is closed, it will no longer appear in the list of active **Branches**, meaning no further changes can be made. **This action is permanent and cannot be undone**, so ensure that all necessary work is completed or merged before closing the branch.
329+
330+
:::
331+
332+
Here’s how you can close a branch:
333+
334+
<div style={{
335+
position: 'relative',
336+
paddingBottom: 'calc(50.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding
337+
height: 0,
338+
width: '100%'}}>
339+
<iframe
340+
src="https://demo.arcade.software/4k3cjnyfVo8uHtjC2PR2?embed&show_copy_link=true"
341+
title=""
342+
style={{
343+
position: 'absolute',
344+
top: 0,
345+
left: 0,
346+
width: '100%',
347+
height: '100%',
348+
colorScheme: 'light'
349+
}}
350+
frameborder="0"
351+
loading="lazy"
352+
webkitAllowFullScreen
353+
mozAllowFullScreen
354+
allowFullScreen
355+
allow="clipboard-write">
356+
</iframe>
357+
</div>
358+
<p></p>
359+
360+
:::tip[Best Practices]
361+
362+
- **Review before deletion:** Before closing a branch, ensure that all necessary changes have been merged or no longer need to be kept.
363+
- **Coordinate with your team:** If you’re working in a team, ensure that no one is actively using the branch before you close it, to avoid disrupting ongoing work.
364+
:::

0 commit comments

Comments
 (0)