From 3eb092e19ba0fc128f8b2283e6384643ddd3702a Mon Sep 17 00:00:00 2001 From: Mike Jang <3287976+mjang@users.noreply.github.com> Date: Thu, 24 Apr 2025 05:45:24 -0700 Subject: [PATCH 1/2] Update CLOSED_CONTRIBUTIONS.md to clarify internal contribution process Include additional steps from testing --- CLOSED_CONTRIBUTIONS.md | 40 ++++++++++++++++++++++++++++++++-------- 1 file changed, 32 insertions(+), 8 deletions(-) diff --git a/CLOSED_CONTRIBUTIONS.md b/CLOSED_CONTRIBUTIONS.md index 275c2322a..bc0b20d09 100644 --- a/CLOSED_CONTRIBUTIONS.md +++ b/CLOSED_CONTRIBUTIONS.md @@ -24,7 +24,7 @@ The process is as follows: - Merge the changes from the remote (Closed) repository branch with a new branch in the open repository - Open a new pull request in the open repository, where it can be merged -You can get the URL through our internal communication channels: it will be represented in the following steps as ``. +You can get the URL through our internal communication channels: we describe it in the following steps as ``. ## Steps @@ -33,13 +33,37 @@ To create closed content, add the closed repository as a remote to the main repo ```shell cd documentation git remote add internal git@github.com:.git -git fetch +git fetch --all ``` -Check out the remote `main` branch, and use it to create a feature branch. **Ensure that you prefix all branch names with `internal/`** +You should now see the following messages: + +```text +Fetching origin +Fetching internal +``` + +which fetches information from both the: + +- `documentation` repository (origin) +- the `internal` repository at the `` + +Check out the remote `main` branch: ```shell git checkout internal/main +``` + +You'll see a prompt with the latest commit hash from the `` repository. You'll something like: + +```text +documentation git:(16340b12) +``` + +It's a good sign. With that hash, you're now working from the `main` branch of the `` repository. +At this prompt, you can now create a feature branch. To comply with NGINX conventions, **Ensure that you prefix all branch names with `internal/`** + +```shell git checkout -b internal/feature ``` @@ -47,15 +71,15 @@ Once you've finished with your work, commit it and push it to the internal repos ```shell git add . -git commit +git commit -m `message` git push internal ``` -Open a pull request when you are ready to receive feedback from stakeholders. +Open a pull request in the `` repository when you are ready to receive feedback from stakeholders. -After any iterative work, close the pull request. Since the closed repository is a mirror of the open one, we do not merge changes to it. +After any iterative work, close the pull request. Since the closed repository is a mirror of the open one, do **not** merge changes to the mirror. -Change back to the origin `main` branch, create a new branch, merge your internal branch and push to origin. +Change back to the origin `main` branch, create a new branch (`feature`), merge your internal branch, and push to origin. ```shell git checkout main @@ -64,4 +88,4 @@ git merge internal/internal/feature git push origin ``` -Once the content changes have been merged in the open repository, they will synchronize back to the closed repository. \ No newline at end of file +Once the content changes have been merged in the open repository, they will synchronize back to the closed repository. From 9462e0ce9b97e676a026d90e1bf2dbda04cc4d23 Mon Sep 17 00:00:00 2001 From: Mike Jang <3287976+mjang@users.noreply.github.com> Date: Fri, 25 Apr 2025 06:18:49 -0700 Subject: [PATCH 2/2] Progressive disclosure of detail --- CLOSED_CONTRIBUTIONS.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CLOSED_CONTRIBUTIONS.md b/CLOSED_CONTRIBUTIONS.md index bc0b20d09..ba4982b4d 100644 --- a/CLOSED_CONTRIBUTIONS.md +++ b/CLOSED_CONTRIBUTIONS.md @@ -36,6 +36,9 @@ git remote add internal git@github.com:.git git fetch --all ``` +
+Click to review the process in detail + You should now see the following messages: ```text @@ -61,7 +64,9 @@ documentation git:(16340b12) ``` It's a good sign. With that hash, you're now working from the `main` branch of the `` repository. -At this prompt, you can now create a feature branch. To comply with NGINX conventions, **Ensure that you prefix all branch names with `internal/`** +
+ +You can now create a feature branch. To comply with NGINX conventions, **Ensure that you prefix all branch names with `internal/`** ```shell git checkout -b internal/feature