Skip to content

feat: Update closed contribution documentation with new branch #330

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 31, 2025
Merged

feat: Update closed contribution documentation with new branch #330

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7dc116
feat: Update closed contribution documentation with new branch
ADubhlaoich Mar 28, 2025
0b3f828
Merge branch 'main' into docs/change-closed-target
ADubhlaoich Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions CLOSED_CONTRIBUTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ Sensitive content might include:
- Security content, including personally identifying information (PII).
- Content / features that are not yet ready to be announced.

We work in public by default, so this process should only be used on a case by case basis by F5 employees. For standard content releases, review the [Contributing guidelines](/CONTRIBUTING.md)
We work in public by default, so this process should only be used on a case by case basis by F5 employees.

For standard content releases, review the [Contributing guidelines](/CONTRIBUTING.md).

## Overview

Expand All @@ -34,10 +36,10 @@ git remote add internal [email protected]:<closed-url>.git
git fetch
```

Check out the `documentation` branch, and use it to create a feature branch. **Ensure that you prefix all branch names with `internal/`**
Check out the remote `main` branch, and use it to create a feature branch. **Ensure that you prefix all branch names with `internal/`**

```shell
git checkout internal/documentation
git checkout internal/main
git checkout -b internal/feature
```

Expand All @@ -53,7 +55,7 @@ Open a pull request 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.

Change back to `main`, create a new branch, merge your internal branch and push to origin.
Change back to the origin `main` branch, create a new branch, merge your internal branch and push to origin.
Copy link
Contributor

Choose a reason for hiding this comment

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

This line confused me until I realized it's an overview of the commands which follow. So maybe:

Suggested change
Change back to the origin `main` branch, create a new branch, merge your internal branch and push to origin.
With the following commands, check out the `main` branch, create a new branch, merge your internal branch, and push the changes to origin.

Copy link
Member Author

@ADubhlaoich ADubhlaoich Mar 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I'm confused what the value add in your edit suggestion is: the sentence is an imperative instruction telling you exactly what to do, then showing you how to do it.

In context, the instruction is juxtaposed with the exact commands to follow in the code block immediately afterwards, and there is only one thing you could possibly be pushing, so all this seems to do is add unnecessary words.

Copy link
Contributor

@mjang mjang Mar 28, 2025 •
edited by ADubhlaoich
Loading

Choose a reason for hiding this comment

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

The alternative is to be more precise with the commands, something like:

git checkout main
git checkout -b desired-branch-name
git merge internal/other-branch-name
git push origin main

In any case, based on @eepifanova 's suggestion in Slack, this might all become moot.


```shell
git checkout main
Expand Down