Requesting Guidance on Adding an External Backlink in Bitbucket Repository Documentation

[Sabrina Liu]

Hi Community,

I’m looking for guidance on the appropriate way to add an external backlink within a Bitbucket repository’s documentation. Specifically, we’d like to add a link to our company’s website (Homery.com) within our repo’s README or project documentation for reference purposes.

Before proceeding, I want to make sure this is fully compliant with Atlassian and Bitbucket guidelines, since the repository is used collaboratively and is publicly visible.

My questions are:

Are there any restrictions on adding external backlinks (such as linking to a company website) in a Bitbucket Cloud repository's documentation?

Is there a preferred or recommended format for adding external references in a README?

Are there any policies related to promotional links that we should be aware of?

Thanks in advance for any clarification you can provide.

[Ben]

Hi Sabrina,

There is no explicit Atlassian or Bitbucket Cloud policy that prohibits adding external links (including company websites) in public repository documentation such as README files. Bitbucket documentation supports Markdown and other markup languages, which allow for standard hyperlink formatting.

This is the formatting guidelines for including a hyperlink in your Readme:

[Link Text](https://www.example.com)

So for your website, for example:

[Homery.com](https://www.homery.com/)

Hope this helps, please let me know if you have further questions.

Cheers!

- Ben (Bitbucket Cloud Support)