From 36fd434a36a527f5517505995e64869695054817 Mon Sep 17 00:00:00 2001 From: Steven Murawski Date: Fri, 9 Feb 2018 11:12:08 -0600 Subject: [PATCH] update to the README with contributing instructions --- README.md | 48 ++++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 6a26459..70b3a0f 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,35 @@ -# Build Tasks +# VSTS Build Extensions from the League -## PowerShell Build +## Description -Tasks to make linting, testing, and publishing PowerShell modules delightful. +This project exists to add common build and release tasks to support workflows that are encouraged by [the League](http://aka.ms/theleague). -Inputs: +There are language specific tasks, as well as general purpose tasks. These tasks also augment and support pipelines built by the [Yo Team](https://github.com/darquewarrior/generator-team) generator. -* `actionType` / Action - Build Action to Perform - * `syntax` / Validate PowerShell Syntax - * `lint` / Lint with PSScriptAnalyzer - * `unit` / Run Unit Tests with Pester +## Contributing -Example: +### CI -```yaml -queue: - name: Hosted VS2017 +This project is being built in VSTS. The build definition is in `.vsts-ci.yml`. -steps: -- task: LoECDA.68377f11-49ef-47cc-8f89-8521c12dc65e.c7f221ba-f39c-47b0-bdf8-aa9ca2a13cdb.PowerShellBuild@0 - displayName: Lint - inputs: - actionType: "lint" +### Common -- task: LoECDA.68377f11-49ef-47cc-8f89-8521c12dc65e.c7f221ba-f39c-47b0-bdf8-aa9ca2a13cdb.PowerShellBuild@0 - displayName: Unit - inputs: - actionType: "unit" +* Create a Branch (or fork the project and create a branch). -``` +### Fixing a bug + +* If you are not changing the behavior of a task, you can dig right in and fix the bug (making sure all tests pass). + +### Modifying an existing task + +* We start with the documentation. Edit the `overview.md` document to add the documentation for the task you want to add, including any inputs it may take. +* Start a pull request with those edits to the `overview.md` and after the documentation looks good to the maintainers, we can start updating the task itself. +* Continue to update the pull request with the changes to the task. +* NEED MORE STEPS HERE + +### Creating a new task + +* We start with the documentation. Edit the `overview.md` document to add the documentation for the task you want to add, including any inputs it may take. +* Start a pull request with those edits to the `overview.md` and after the documentation looks good to the maintainers, we can start adding the task itself. +* Create a folder for your task. This folder must have a [`task.json` file](https://docs.microsoft.com/en-us/vsts/extend/develop/build-task-schema). +* NEED MORE STEPS HERE