Skip to content

Commit 8a958c9

Browse files
Update to 3 in STEP and README.md
1 parent f0a3bd4 commit 8a958c9

File tree

2 files changed

+21
-40
lines changed

2 files changed

+21
-40
lines changed

.github/steps/-step.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2
1+
3

README.md

Lines changed: 20 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -16,59 +16,40 @@ _Create a release based workflow that is built on the foundations of the GitHub
1616
</header>
1717

1818
<!--
19-
<<< Author notes: Step 2 >>>
19+
<<< Author notes: Step 3 >>>
2020
Start this step by acknowledging the previous step.
2121
Define terms and link to docs.github.com.
2222
-->
2323

24-
## Step 2: Add a new feature to the release branch
24+
## Step 3: Open a release pull request
2525

26-
_Great job creating a beta release :heart:_
26+
_Nice work adding a new feature :smile:_
2727

28-
### Release management
28+
### Release branches and `main`
2929

30-
As you prepare for a future release, you'll need to organize more than the tasks and features. It's important to create a clear workflow for your team, and to make sure that the work remains organized.
30+
You should open a pull request between your release branch and main as early as possible. It might be open for a long time, and that's okay.
3131

32-
There are several strategies for managing releases. Some teams might use long-lived branches, like `production`, `dev`, and `main`. Some teams use simple feature branches, releasing from the main branch.
32+
In general, the pull request description can include:
3333

34-
No one strategy is better than another. We always recommend being intentional about branches and reducing long-lived branches whenever possible.
34+
- A [reference to an issue](https://docs.github.com/en/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) that the pull request addresses.
35+
- A description of the changes proposed in the pull request.
36+
- [@mentions](https://docs.github.com/en/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) of the person or team responsible for reviewing proposed changes.
3537

36-
In this exercise, you'll use the `release-v1.0` branch to be your one long-lived branch per release version.
38+
To expedite the creation of this pull request, I've added a pull request template to the repository. When you create a pull request, default text will automatically be displayed. This should help you identify and fill out all the necessary information. If you don't want to use the template content, just remove the text from the pull request and replace it with your pull request message.
3739

38-
### Protected branches
40+
### :keyboard: Activity: Open a release pull request
3941

40-
Like the `main` branch, you can protect release branches. This means you can protect branches from force pushes or accidental deletion. This is already configured in this repository.
42+
Let's make a new pull request comparing the `release-v1.0` branch to the `main` branch.
4143

42-
### Add a feature
43-
44-
Releases are usually made of many smaller changes. Let's pretend we don't know about the bug we added earlier and we'll focus on a few features to update our game before the version update.
45-
46-
- You should update the page background color to black.
47-
- I'll help you change the text colors to green.
48-
49-
### :keyboard: Activity: Update `base.css`
50-
51-
1. Create a new branch off of the `main` branch and change the `body` CSS declaration in `base.css` to match what is below. This will set the page background to black.
52-
53-
```
54-
body {
55-
background-color: black;
56-
}
57-
```
58-
59-
1. Open a pull request with `release-v1.0` as the `base` branch, and your new branch as the `compare` branch.
60-
1. Fill in the pull request template to describe your changes.
44+
1. Open a **new pull request** with `base: main` and `compare: release-v1.0`.
45+
1. Ensure the title of your pull request is "Release v1.0".
46+
1. Include a detailed pull request body, an example is below:
47+
```
48+
## Description:
49+
- Changed page background color to black.
50+
- Changed game text color to green.
51+
```
6152
1. Click **Create pull request**.
62-
63-
### Merge the new feature to the release branch
64-
65-
Even with releases, the GitHub flow is still an important strategy for working with your team. It's a good idea to use short-lived branches for quick feature additions and bug fixes.
66-
67-
Merge this feature pull request so that you can open the release pull request as early as possible.
68-
69-
### :keyboard: Activity: Merge the pull request
70-
71-
1. Click **Merge pull request**, and delete your branch.
7253
1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.
7354

7455
<footer>

0 commit comments

Comments
 (0)