-
Notifications
You must be signed in to change notification settings - Fork 798
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update contribution guide #3
Conversation
jcorioland
commented
May 15, 2019
- Update the how to work with locally built provider section
- Add instruction on how to get started with developing the Azure RM provider, using the Azure SDK for Go etc...
@grayzu fyi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few minor changes to wording.
@JunyiYi can you have a quick look to ensure that best practices are being suggested here.
provider/CONTRIBUTE.md
Outdated
@@ -1,6 +1,7 @@ | |||
# Contribute to Terraform AzureRM provider | |||
|
|||
This document describe how you can get ready to contribute to the [AzureRM Terraform provider](https://github.com/terraform-providers/terraform-provider-azurerm). | |||
We also recommand that your read the [README](https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/README.md) on the AzureRM Terraform Provider repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling: "... recommend that you ..."
provider/CONTRIBUTE.md
Outdated
|
||
*Note: we also invite you to read the official documentation about developing a provider [here](https://www.terraform.io/docs/plugins/basics.html#developing-a-plugin)* | ||
|
||
First you need to pick [an issue on the provider](https://github.com/terraform-providers/terraform-provider-azurerm/issues) by commenting the issue and saying that you're going to work on that, to make sure that HashiCorp people who maintain the repository and will review your contribution are aware that you are going to work on that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
update wording to "... to make sure that the repo maintainers are aware that you are going to work on this issue." We should also have them submit the schema that they intend to implement so that feedback can be provided on that before it is implemented. This will save significant rework.
@grayzu I've just done the update you have requested |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @jcorioland for the contributions. The documentation looks good to me. I have provided some comments here, and it would be good to go when they are resolved.
Thanks @JunyiYi for the review. I have pushed updates according to your comments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @jcorioland for the update, approved.