Skip to content
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

feat: add contributing docs #1229

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

rodcoffani
Copy link

Create contributing documentation for terraform-provider-mgc:

  • Updates README with description of sub-directory
  • Fixes broken links on README
  • Creates mgc/terraform-provider-mgc/CONTRIBUTING.md
  • Adds make build command for the terraform-provider-mgc

@@ -107,4 +107,10 @@ setup-config: ## Setup configuration file for Terraform or OpenTofu
@echo "File $$config_file written to $$HOME:"
@cat $$config_file

build: ## Build the plugin
Copy link
Member

@luizcavalcanti luizcavalcanti Nov 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!
We can be more specific here and call it build-tf or something similar.

Also we can leverage goreleaser, with some goreleaser build --snapshot --clean --single-target --config=goreleaser_internal.yaml, which builds it according to plan and uses proper version number (algo is user-platform-specific)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review and suggestions! About the goreleaser, i didn't know about it, thank you for the tip.
As it is installed locally, what you think would be the best way to integrated with the script? Document as a pre-requisite or use the bash script?

@luizcavalcanti
Copy link
Member

luizcavalcanti commented Nov 7, 2024

Hi @rodcoffani , thank you so much for your contribution. 💙
It looks good to me, overall. Made some small suggestion.

@geffersonFerraz geffersonFerraz added the documentation Improvements or additions to documentation label Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants