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: adjust contributing docs

Browse source
This commit is contained in:
Jan De Dobbeleer 2020-12-25 20:48:14 +01:00
parent ed2eac8e12
commit c4cb6772e9
2 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -3,8 +3,8 @@
Note we have a code of conduct, please follow it in all your interactions with the project. 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 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 project. If you're looking to get familiar with go, following the getting started [guide][guide]
segments can be a good starting point. can be a good starting point.
## Pull Request Process ## 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). enforcement ladder](https://github.com/mozilla/diversity).
[docs]: https://ohmyposh.dev/docs [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 [cc]: https://www.conventionalcommits.org/en/v1.0.0/#summary
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org
[conduct]: mailto:conduct@ohmyposh.dev [conduct]: mailto:conduct@ohmyposh.dev

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

@ -76,14 +76,15 @@ git clone git@github.com:<user>/oh-my-posh3.git
## Running tests ## 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 ```bash
go generate go generate
``` ```
Provided the previous steps were performed correctly, you should now see a new source file called `init.go`. 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, we generate it every time the app gets build. Do not wory about this file as it's ignored by git, we generate it every time the app gets build.
### Unit tests ### Unit tests