# How can I document a branch?

**URL:** <https://forum.gitea.com/t/how-can-i-document-a-branch/6621>\
**Category:** Gitea Usages\
**Created:** [January 27, 2023, 4:06pm UTC](https://forum.gitea.com/t/how-can-i-document-a-branch/6621 "2023-01-27T16:06:37Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Utopiah](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.gitea.com/utopiah/32/3083_2.png) [@Utopiah](https://forum.gitea.com/u/Utopiah)\
**Post date:** [January 27, 2023, 4:06pm UTC](https://forum.gitea.com/t/how-can-i-document-a-branch/6621/1 "2023-01-27T16:06:38Z")

</div>

Hi, I have few branches and hopefully their names are explicit enough. Yet, I’d like to provide a short description for each to describe the purpose and the current state. Is it possible already and if so how?

---

<div class="post-metadata">

**Author:** ![jake](https://avatars.discourse-cdn.com/v4/letter/j/f475e1/32.png) [@jake](https://forum.gitea.com/u/jake)\
**Post date:** [January 28, 2023, 7:22am UTC](https://forum.gitea.com/t/how-can-i-document-a-branch/6621/2 "2023-01-28T07:22:39Z")

</div>

You can use `git branch --edit-description` on local repository, but note these are stored in repository’s config so they are not synced to remote. Would work if it is only for your purposes, but won’t work for team purposes.

As for Gitea, there is no feature to show/edit branch descriptions unfortunately. You can create suggestion on GitHub [GitHub - go-gitea/gitea: Git with a cup of tea, painless self-hosted git service](https://github.com/go-gitea/gitea) for this.

---

<div class="post-metadata">

**Author:** ![Utopiah](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.gitea.com/utopiah/32/3083_2.png) [@Utopiah](https://forum.gitea.com/u/Utopiah)\
**Post date:** [January 28, 2023, 8:59am UTC](https://forum.gitea.com/t/how-can-i-document-a-branch/6621/3 "2023-01-28T08:59:53Z")

</div>

Thanks, added as [Branch description · Issue #22639 · go-gitea/gitea · GitHub](https://github.com/go-gitea/gitea/issues/22639)
