Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# 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.
Comment thread
stuartleeks marked this conversation as resolved.

## 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).