From 9308009c0418c4baf2b7b88f2f9376fe18ebe3c9 Mon Sep 17 00:00:00 2001 From: Stuart Leeks Date: Fri, 3 Feb 2023 10:29:53 +0000 Subject: [PATCH 1/2] Initial thoughts on contrib doc --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5a765d614 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +This repo contains a dev container that is intended to be used for developing the project. + +As a general rule, it is recommended that you create an issue to discuss proposed changes/features before investing too much effort implementing it. For small changes/fixes, it may be easier to just create a PR and discuss it there. + +## Repo Structure + +The repo contains code for both a GitHub action and Azure DevOps Pipeline Task. +The code for each is contained in a separate folder. + +The main folders in the repo are: + +| Folder | Description | +| --------------- | ---------------------------------------------------------------------------------------------- | +| `azdo-task` | Code for the Azure DevOps Pipeline Task | +| `common` | Common code used by both the GitHub Action and Azure DevOps Pipeline Task | +| `docs` | Documentation for using the action/task | +| `github-action` | Code for the GitHub Action | +| `github-tests` | This folder contains various test projects that are used by the CI for GitHub and Azure DevOps | + + +## Workflow + +The code for both the GitHub Action and Azure DevOps Pipeline Task is written in TypeScript. Since the GitHub action is pulled from the project repo when executed, any PRs should also include the output of the build process. + +To run the build step locally, run `./scripts/build.sh` from the root of the repo. + +The intention is for the GitHub action and Azure DevOps task to maintain feature parity as far as possible. As a general rule, and changes should be implemented in both the GitHub action and the Azure DevOps task. + +Additionally, it is desirable to add new tests to cover any new functionality. + +When a PR is created, some tests will be automatically triggered against the PR. The full suite of tests requires secrets and needs to be triggered by a maintainer. From c29ec608f35052ce9b6e472a6188da0779486f7e Mon Sep 17 00:00:00 2001 From: Stuart Leeks Date: Fri, 3 Feb 2023 12:48:39 +0000 Subject: [PATCH 2/2] Add Misc section as per feedback --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a765d614..f2ca04616 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,3 +31,11 @@ The intention is for the GitHub action and Azure DevOps task to maintain feature Additionally, it is desirable to add new tests to cover any new functionality. When a PR is created, some tests will be automatically triggered against the PR. The full suite of tests requires secrets and needs to be triggered by a maintainer. + +## Miscellaneous + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +This project is under an [MIT license](LICENSE.txt).