> For the complete documentation index, see [llms.txt](https://docs.flxbl.io/flxbl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flxbl.io/flxbl/techniques/source-code-management/branching-conventions.md).

# Branching Conventions

Flxbl follows the below branching conventions when they are creating branches.

| Branch      | Used For                                                                                                                              | Restrictions                                                                                                                                                                                                                                                                                                                   |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| main        | The key that is actively used for development and should be always in a deployable state                                              | No direct merges to this branch is allowed. Please read more information on branching model.                                                                                                                                                                                                                                   |
| feature/XYZ | A feature branch that a developer is working on . The XYZ denotes the issue id in your issue registry or User Story in your ALM tool. | Long lived feature branches are discouraged. As soon as a unit of a work (if its a large feature, as soon as a meaningful part is completed, a pull request is to be raised for merging into main) . Feature branch merges are typically not allowed to be merged into release branches. Check branching model for exceptions. |
| bugfix/XYZ  | A bug fix branch that a developer is working on. The XYZ denotes the issue id in your issue registry or User Story in your ALM tool.  |                                                                                                                                                                                                                                                                                                                                |
| chore/XYZ   | Updates to pipelines and other scripts, not necessarily related to the functionality delivered to the platform.                       |                                                                                                                                                                                                                                                                                                                                |

## Commit Message

We typically prefer (feature/bugfix/chore) branches be merged to the main/master or release branches using squash as the option. When it is being merged, most git repository systems allow to combine and edit the commit messages. The commit messages from multiple commits in feature branch should be cleaned up and should follow the similar format

```
[XYZ] Short Commit Message
- Commit Details
- Commit Details
```

In the above example \[XYZ] denotes the work item number in the issue registry and is utilized by Flxbl tools to generate meaningful change logs.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.flxbl.io/flxbl/techniques/source-code-management/branching-conventions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.