link contrib docs in readme and dev mds (hashicorp#17591)

Co-authored-by: Matthew Frahry <[email protected]>
lee0210 · Jul 11, 2022 · 82b36a7 · 82b36a7
1 parent c19e94d
commit 82b36a7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/DEVELOPER.md b/DEVELOPER.md
@@ -3,6 +3,10 @@
 * [Terraform (Core)](https://www.terraform.io/downloads.html) - version 1.x (0.12.x and above are compatible however 1.x is recommended)
 * [Go](https://golang.org/doc/install) version 1.18.x (to build the provider plugin)
 
+## Contributor Guides
+
+A Collection of guides geared towards contributors can be found in the [`/contributing`](https://github.com/hashicorp/terraform-provider-azurerm/tree/main/contributing) directory of this repository.
+
 ### On Windows
 
 If you're on Windows you'll also need:

diff --git a/README.md b/README.md
@@ -58,6 +58,6 @@ resource "azurerm_virtual_network" "example" {
 * [Learn more about Terraform and the AzureRM Provider on HashiCorp Learn](https://learn.hashicorp.com/collections/terraform/azure-get-started).
 * [Additional examples can be found in the `./examples` folder within this repository](https://github.com/hashicorp/terraform-provider-azurerm/tree/main/examples).
 
-## Developing the Provider
+## Developing & Contributing to the Provider
 
-See [DEVELOPER.md](DEVELOPER.md).
+The [DEVELOPER.md](DEVELOPER.md) file is a basic outline on how to build and develop the provider while more detailed guides geared towards contributors can be found in the [`/contributing`] (https://github.com/hashicorp/terraform-provider-azurerm/tree/main/contributing) directory of this repository.
diff --git a/contributing/README.md b/contributing/README.md
@@ -1,4 +1,4 @@
-# AzureRM Provider Contributor Docs
+    # AzureRM Provider Contributor Guides
 
 **First,** thank you for your interest in contributing to the Azure Provider! And if you're unsure or anything, please do reach out for help. You can open a draft pull request (PR) or an issue with what you know or join the [Slack Workspace for Contributors](https://terraform-azure.slack.com) ([Request Invite](https://join.slack.com/t/terraform-azure/shared_invite/enQtNDMzNjQ5NzcxMDc3LWNiY2ZhNThhNDgzNmY0MTM0N2MwZjE4ZGU0MjcxYjUyMzRmN2E5NjZhZmQ0ZTA1OTExMGNjYzA4ZDkwZDYxNDE)) and we'll do our best to guide you in the right direction.