Skip to content

Commit

Permalink
chore: extend contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JanDeDobbeleer committed Dec 25, 2020
1 parent e27b21b commit ef51c9d
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/docs/contributing-started.mdx
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Get Started
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

## Getting started
## Install dependencies

### go

Expand Down Expand Up @@ -63,6 +63,17 @@ Make sure to remove this before submitting a PR as there's [a check][pr-go-mod]
</TabItem>
</Tabs>

## 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 `<user>` with your Github username.

```bash
git clone git@github.com:<user>/oh-my-posh3.git
```

## Running tests

Before doing anything else, we need to pack the initialization scripts into the source.
Expand Down Expand Up @@ -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/

0 comments on commit ef51c9d

Please sign in to comment.