From c4cb6772e9371bd69941b20f60959f56c99918b9 Mon Sep 17 00:00:00 2001 From: Jan De Dobbeleer Date: Fri, 25 Dec 2020 20:48:14 +0100 Subject: [PATCH] chore: adjust contributing docs --- CONTRIBUTING.md | 6 +++--- docs/docs/contributing-started.mdx | 7 ++++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66999c9a..910f5df6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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 diff --git a/docs/docs/contributing-started.mdx b/docs/docs/contributing-started.mdx index b3f87246..998145f8 100644 --- a/docs/docs/contributing-started.mdx +++ b/docs/docs/contributing-started.mdx @@ -76,14 +76,15 @@ 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. +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