Skip to content
This repository has been archived by the owner on May 15, 2023. It is now read-only.

Expand documentation on contributing new resources #514

Merged
merged 3 commits into from
Feb 8, 2022

Conversation

iyabchen
Copy link
Contributor

@iyabchen iyabchen commented Feb 8, 2022

#245

  • mentioned compile_common_files and copy_common_files
  • added IAM handwritten file need to add merge functions and fetch functions
  • added adding test file example steps

@iyabchen iyabchen requested a review from a team as a code owner February 8, 2022 15:22
@iyabchen iyabchen requested review from ScottSuarez and melinath and removed request for a team and ScottSuarez February 8, 2022 15:22
Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

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

LGTM - definitely an improvement!

docs/contributing/add_new_resource.md Outdated Show resolved Hide resolved
Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

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

I think this might actually be a little out of date - specifically, the part about Add your new test cases to test/cli_test.go... - nowadays I think they get added to https://github.com/GoogleCloudPlatform/magic-modules/tree/master/mmv1/third_party/validator/tests/data, and the compilation code automatically detects them and adds them to the lists in cli_test and read_test.

I think it's out of scope for this change - but we can also generate tests automatically these days, though it may require changing the test generation allowlist. Some details on this in b/211888856#comment2.

Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

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

LGTM

docs/contributing/add_new_resource.md Outdated Show resolved Hide resolved
Co-authored-by: Stephen Lewis (Burrows) <[email protected]>
@iyabchen iyabchen merged commit a0f7ef2 into GoogleCloudPlatform:main Feb 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants