From 19580bdaf82b1258937c61db338c4527bfc73b59 Mon Sep 17 00:00:00 2001 From: Eilon Lipton Date: Tue, 5 Nov 2019 14:21:50 -0800 Subject: [PATCH] Update contribute.md (#175) Small cleanup of contribution guide --- docs/contribute.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/contribute.md b/docs/contribute.md index 4546f2135..2a0f88448 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -1,12 +1,12 @@ -# Contribute (Dev) +# Contribution guide for developers -## Dev Dependencies +## Required Dev Dependencies ![Win](res/win_sm.png) Git for Windows [Install Here](https://git-scm.com/downloads) (needed for dev sh script) -## Build, Test, Layout +## To Build, Test, Layout -From src: +Navigate to the `src` directory and run the following command: ![Win](res/win_sm.png) `dev {command}` @@ -14,13 +14,12 @@ From src: **Commands:** -`layout` (`l`): Run first time to create a full agent layout in {root}/_layout +* `layout` (`l`): Run first time to create a full agent layout in `{root}/_layout` +* `build` (`b`): Build everything and update agent layout folder +* `test` (`t`): Build agent binaries and run unit tests -`build` (`b`): build everything and update agent layout folder +Sample developer flow: -`test` (`t`): build agent binaries and run unit tests - -Normal dev flow: ```bash git clone https://github.com/actions/runner cd ./src @@ -37,5 +36,5 @@ cd ./src ## Styling -We use the dotnet foundation and CoreCLR style guidelines [located here]( +We use the .NET Foundation and CoreCLR style guidelines [located here]( https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md)