-
Notifications
You must be signed in to change notification settings - Fork 14
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
Docs: Add guidelines for contributors #609
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 tasks
mawasile
reviewed
Mar 3, 2025
…d streamline contribution process
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.
Minor updates requested
Co-authored-by: Ian Jensen <94021216+ianjensenisme@users.noreply.github.com>
mawasile
reviewed
Mar 5, 2025
mawasile
reviewed
Mar 5, 2025
mawasile
reviewed
Mar 5, 2025
mawasile
reviewed
Mar 5, 2025
mawasile
reviewed
Mar 5, 2025
mawasile
previously approved these changes
Mar 5, 2025
eduardodfmex
reviewed
Mar 5, 2025
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.
Thank you for creating and extending the documentation..!
I add a couple of suggestions.
eduardodfmex
reviewed
Mar 6, 2025
…ules for resources and data sources
…nd streamlining instructions
Co-authored-by: mawasile <50197777+mawasile@users.noreply.github.com>
Co-authored-by: mawasile <50197777+mawasile@users.noreply.github.com>
Co-authored-by: Eduardo Sanchez <eduardodfmex@hotmail.com>
Co-authored-by: Eduardo Sanchez <eduardodfmex@hotmail.com>
…thub.com/microsoft/terraform-provider-power-platform into 608-developer-documentation-improvements
leighatami
approved these changes
Mar 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes updates to the documentation and developer guidelines for the Terraform Provider for Power Platform. The changes aim to provide clearer instructions for contributors and improve the overall structure of the documentation. The most important changes include adding a dynamic configuration guide, enhancing the contribution guidelines, and reorganizing developer resources.
Documentation updates:
.changes/unreleased/documentation-20250303-071315.yaml
: Added a dynamic configuration guide to the user documentation.CONTRIBUTING.md
: Reorganized and expanded the contribution guidelines, including a new section on examples and clarifying the process for contributing new resources and data sources.Developer guidelines:
DEVELOPER.md
: Reorganized the developer documentation, added a summary of developer resources, and detailed the developer workflow, including setting up development environments using GitHub Codespaces or local devcontainers.DEVELOPER.md
: Updated the section on testing guidelines to provide detailed instructions on writing unit and acceptance tests, and the importance of comprehensive test coverage.This pull request to the Terraform Provider for Power Platform repository includes significant updates to theCONTRIBUTING.md
andDEVELOPER.md
files, as well as the addition of new documentation files. The changes aim to improve the contribution guidelines, developer setup instructions, and testing practices. The most important changes include restructuring the contribution types, enhancing developer resource documentation, and adoptinghttpmock
for unit testing.Contribution Guidelines and Examples:
CONTRIBUTING.md
: Restructured the contribution types section to clarify the difficulty levels of different contributions and added detailed examples for contributing to the Power Platform Terraform Provider.Developer Setup and Resources:
DEVELOPER.md
: Enhanced the documentation by adding a comprehensive summary of developer resources, including guidelines for testing, security, schema design, and community support. Introduced two recommended development environment options: GitHub Codespaces and Local Devcontainer.DEVELOPER.md
: Provided detailed instructions for setting up and configuring Git credentials in both GitHub Codespaces and Local Devcontainer environments.Decision Logs and Testing:
decision-log/loosely_typed_resources.md
: Removed the decision log for loosely typed resources, which outlined the rationale and comparison between strongly typed and loosely typed resources in the Terraform Provider for Power Platform.devdocs/adr/httpmocks.md
: Added a new ADR document detailing the adoption ofhttpmock
for HTTP request mocking in unit tests, highlighting the benefits and implementation guidelines for improved test reliability and determinism.This pull request includes several documentation updates and additions to improve clarity and support for developers and users of the Terraform Provider for Power Platform. The most important changes are summarized below:Documentation Updates:
Decision Log Removal:
decision-log/loosely_typed_resources.md
.New ADR Document:
powerplatform_data_record
andpowerplatform_data_records
indevdocs/adr/loosely_typed_data_records.md
.Community Support Documentation:
devdocs/community_support.md
.Observability and Logging Guidelines:
tflog
package for structured logging and the importance of not logging sensitive information indevdocs/observability_guidelines.md
.