Skip to content

Commit

Permalink
chore: adjust contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JanDeDobbeleer committed Dec 25, 2020
1 parent ed2eac8 commit c4cb677
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -3,8 +3,8 @@
Note we have a code of conduct, please follow it in all your interactions with the project.

Ensure you've read through the [documentation][docs] so you understand the core concepts of the
project. If you're looking to get familiar with Go, following the [guide][guide] for adding
segments can be a good starting point.
project. If you're looking to get familiar with go, following the getting started [guide][guide]
can be a good starting point.

## Pull Request Process

Expand Down Expand Up @@ -137,7 +137,7 @@ Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[docs]: https://ohmyposh.dev/docs
[guide]: https://ohmyposh.dev/docs/contributing_segment
[guide]: https://ohmyposh.dev/docs/contributing_started
[cc]: https://www.conventionalcommits.org/en/v1.0.0/#summary
[homepage]: https://www.contributor-covenant.org
[conduct]: mailto:conduct@ohmyposh.dev
Expand Down
7 changes: 4 additions & 3 deletions docs/docs/contributing-started.mdx
Expand Up @@ -76,14 +76,15 @@ 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.
The go source code can be found in the `src/` directory, make sure to change to that one before continuing.
Once in the right directory, we need to pack the initialization scripts into the source code.

```bash
go generate
```

Provided the previous steps were performed correctly, you should now see a new source file called `init.go`.
Do not wory about this file as it's ignored, we generate it every time the app gets build.
Provided the previous steps were performed correctly, you should now see a new file called `init.go`.
Do not wory about this file as it's ignored by git, we generate it every time the app gets build.

### Unit tests

Expand Down

0 comments on commit c4cb677

Please sign in to comment.