diff --git a/docs/docs/contributing-started.mdx b/docs/docs/contributing-started.mdx index 73bf0a48ba9e..b3f87246ea68 100644 --- a/docs/docs/contributing-started.mdx +++ b/docs/docs/contributing-started.mdx @@ -7,7 +7,7 @@ sidebar_label: Get Started import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -## Getting started +## Install dependencies ### go @@ -63,6 +63,17 @@ Make sure to remove this before submitting a PR as there's [a check][pr-go-mod] +## Get the source code + +The source is hosted on [Github][omp]. When you want to contribute, create a [fork][gh-fork] so you can make changes in your repository +and create pull request in the official Oh my Posh repository. + +Clone your fork of Oh my Posh locally, replace `` with your Github username. + +```bash +git clone git@github.com:/oh-my-posh3.git +``` + ## Running tests Before doing anything else, we need to pack the initialization scripts into the source. @@ -108,3 +119,5 @@ With everything set up, you're ready to start making changes and create your fir [go-global]: https://github.com/golang/go/issues/40276 [pr-go-mod]: https://github.com/JanDeDobbeleer/oh-my-posh3/blob/main/.github/workflows/gomod.yml [gh-pr]: https://github.com/JanDeDobbeleer/oh-my-posh3/pulls +[omp]: https://github.com/JanDeDobbeleer/oh-my-posh3 +[gh-fork]: https://guides.github.com/activities/forking/