Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (39 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.89 KB

Contributing to Bicep Azure DevOps extension

Every contribution is welcome to the Bicep Azure DevOps extension. We make use of GitHub issues to track reported issues by the community. GitHub pull request are used to merge in code changes.

Contribution Workflow

Code contributions follow a GitHub-centered workflow. To participate in the development of the Bicep Azure DevOps extension, you require a GitHub account first.

Then, you can follow the steps below:

  1. Fork this repo by going to the project repo page and use the _Fork` button.

  2. Clone down the repo to your local system

    git clone https://github.com/<username>/azure-devops-bicep-local-deploy.git

  3. Create a new branch to hold your code changes you want to make:

    git checkout -b branch-name

  4. Work on your code and test it if applicable.

When you are done with your work, make sure you commit the changes to your branch. Then, you can open a pull request on this repository.

Adding a new resource

To add a new resource:

  1. Create a new directory FeatureX directory
  2. Implement the handler and model
  3. Test your changes locally by running bicep local-deploy or use grpcurl
  4. Run dotnet tool restoreand bicep-local-docgen generate .\src --force to update documentation
  5. Open a PR for review

Note

The directory structure follows the REST API reference on the official Azure DevOps REST API documentation.

Code conventions