mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2025-03-05 20:49:04 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: extend contributing docs

Browse source
This commit is contained in:
Jan De Dobbeleer 2020-12-25 19:37:18 +01:00 committed by Jan De Dobbeleer
parent e27b21bf23
commit ef51c9d3c5
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/docs/contributing-started.mdx
View file

@ -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]
</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.
@ -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/