Skip to content

Commit

Permalink
Update README and PR Template
Browse files Browse the repository at this point in the history
  • Loading branch information
arnaudlh committed Feb 15, 2022
1 parent 61df9e1 commit 5a43613
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ Please, find below the steps that should be followed to contribute:

You can run `make build` in case you have make installed in your system in case you don't you can run from the repository root `go generate` followed by `go fmt ./...` and them `go test ./...`

7. Update the README.MD with coverage

For quick reference, update the [README.md#resource-status](../README.md) at the root of the provider to mention the coverage you just added:
```|azurerm_api_management_custom_domain | ✔ |```

7. Commit and submit PR

Now you should commit, remembering to put a meaningful commit message. After that, you should [make pull request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) remembering to link in the PR the issue that it is solving.
Expand Down
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# [Issue-id](https://github.com/Azure/caf-terraform-landingzones/issues/ISSUE-ID-GOES-HERE)

## PR Checklist

---

<!-- Use the check list below to ensure your branch is ready for PR. -->

- [ ] I have read the [CONTRIBUTING.MD instructions](./CONTRIBUTING.md)
- [ ] I have changed the `resourceDefinition.json`
- [ ] I have generated the resource model (there's a ```models_generated.go``` file in my PR)
- [ ] I have updated the [README.md#resource-status](../README.md)
- [ ] I have checked to ensure there aren't other open Pull Requests for the same update/change?

## Description

<!-- Concise description of the problem and the solution or the feature being added -->

## Does this introduce a breaking change

- [ ] YES
- [ ] NO

<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->

## Testing

<!-- Instructions for testing and validation of your code -->
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ This is the current compreheensive status of the implemented resources in the pr
|azurerm_api_management_certificate ||
|azurerm_api_management_custom_domain ||
|azurerm_api_management_diagnostic ||
|azurerm_api_management_gateway ||
|azurerm_api_management_group ||
|azurerm_api_management_group_user ||
|azurerm_api_management_identity_provider_aad ||
Expand Down
2 changes: 1 addition & 1 deletion azurecaf/models_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5a43613

Please sign in to comment.