Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#1068)
Browse files Browse the repository at this point in the history
Updating to call out listing examples alphabetically.
  • Loading branch information
JFolberth authored Dec 3, 2020
1 parent fca8882 commit 221b840
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ If you'd like to contribute example `.bicep` files that showcase abilities of th
* Create an appropriately-named directory inside `docs/examples`. Note that the directory naming matches that of the [azure quickstart template repo](https://github.com/Azure/azure-quickstart-templates).
* Include your file named `main.bicep`.
* Compile the file using the Bicep CLI, and include the compiled `main.json` with your check-in.
* Update the `src/playground/src/examples.ts` to import the newly defined `.bicep` file and then add it to the `examples` object with the name you'd like it to appear in the playground
* Update the `src/playground/src/examples.ts` to import the newly defined `.bicep` file and then add it to the `examples` object with the name you'd like it to appear in the playground. Please note that examples are listed alphabetically under each folder to improve visibility when navigating within the playground.
* Pull Request validation checks the following:
1. All `.bicep` files in `docs/examples` can be compiled without errors.
1. All `.bicep` files have a corresponding `.json` file which exactly matches that generated by the Bicep compiler.
Expand Down

0 comments on commit 221b840

Please sign in to comment.