Skip to content

Commit

Permalink
Renamecontribute (GoogleCloudPlatform#12583)
Browse files Browse the repository at this point in the history
Co-authored-by: Stephen Lewis (Burrows) <[email protected]>
  • Loading branch information
2 people authored and amanMahendroo committed Dec 17, 2024
1 parent 0532d1c commit 1a401ec
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 9 deletions.
4 changes: 4 additions & 0 deletions docs/content/code-review/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Code review"
weight: 50
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Create a pull request"
weight: 10
aliases:
- /contribute/create-pr
---

# Create a pull request (PR)
Expand All @@ -12,7 +14,7 @@ weight: 10
- If you are adding a few fields and also fixing a bug, create one PR for adding the new fields and a separate PR for the bugs.
1. Follow the instructions at [Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to create a pull request to merge your branch into `GoogleCloudPlatform/magic-modules`.
- Make sure the PR body includes the text `Fixes GITHUB_ISSUE_LINK.` once per issue resolved by your PR. Replace `GITHUB_ISSUE_LINK` with a link to a GitHub issue from the [provider issue tracker](https://github.com/hashicorp/terraform-provider-google/issues).
- [Write release notes]({{< ref "/contribute/release-notes" >}})
- [Write release notes]({{< ref "/code-review/release-notes" >}})

## Code review

Expand All @@ -28,7 +30,7 @@ weight: 10
- You can push them and test in parallel as well. New CI runs will preempt old ones where possible.
1. Resolve failed [status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks) quickly
- Directly ask your reviewer for help if you don't know how to proceed. If there are failed checks they may only check in if there's no progress after a couple days.
1. [Self-review your PR]({{< ref "/contribute/review-pr" >}}) or ask someone else familiar with Terraform to review
1. [Self-review your PR]({{< ref "/code-review/review-pr" >}}) or ask someone else familiar with Terraform to review
{{< /hint >}}


Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Write release notes"
weight: 20
aliases:
- /contribute/release-notes
---

# Write release notes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Review a pull request"
weight: 30
aliases:
- /contribute/review-pr
---

# Review a pull request
Expand Down
4 changes: 0 additions & 4 deletions docs/content/contribute/_index.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/content/contribution-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ This page explains how you can contribute code and documentation to the `magic-m
+ [Make a breaking change]({{< ref "/breaking-changes/make-a-breaking-change" >}})
1. [Generate the providers]({{< ref "/develop/generate-providers" >}}) that include your change.
1. [Run provider tests locally]({{< ref "/test/run-tests" >}}) that are relevant to the change you made
1. [Create a pull request (PR)]({{< ref "/contribute/create-pr" >}})
1. Make changes in response to [code review]({{< ref "/contribute/create-pr#code-review" >}})
1. [Create a pull request (PR)]({{< ref "/code-review/create-pr" >}})
1. Make changes in response to [code review]({{< ref "/code-review/create-pr#code-review" >}})

## After your change is merged

Expand Down
2 changes: 1 addition & 1 deletion docs/content/test/run-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,4 +298,4 @@ Terraform will resume its normal behaviour of pulling published provider version
## What's next?

[Create a pull request]({{< ref "/contribute/create-pr" >}})
[Create a pull request]({{< ref "/code-review/create-pr" >}})

0 comments on commit 1a401ec

Please sign in to comment.