Question

How can I write bullet points in a Bitbucket pull request description?

Answer and Explanation

To write bullet points in a Bitbucket pull request description, you can utilize Markdown syntax, which Bitbucket supports. Here's how:

1. Using Asterisks () or Hyphens (-):

- You can start a bulleted list by using either an asterisk () or a hyphen (-) followed by a space and your list item. Each new line with the same prefix will be considered a new bullet point.

2. Example Syntax:

For example, using asterisks:

 Item 1
 Item 2
 Item 3
                           
or using hyphens:
- Item A
- Item B
- Item C
                           

3. Result in Bitbucket:

- When you save the description, Bitbucket will render these prefixes as actual bullet points. The text you entered following the asterisk or hyphen will be displayed as the content of the bullet point.

4. Nested Bullet Points:

- To create nested bullet points, add more spaces before the asterisk or hyphen. Typically, two to four spaces are used for each level of nesting.

5. Example of Nested Lists:

 Main item 1
   Sub-item 1
     Sub-sub-item 1
 Main item 2
- Main item 3
  - Sub item 3
    - Sub sub item 3
                           

6. Mixed Styles:

- While you can mix asterisks and hyphens to format list items, it is generally recommended to stick with one type of prefix within the same list for readability and consistency.

By using Markdown's bullet point syntax, you can create structured and easy-to-read pull request descriptions in Bitbucket.

More questions