Skip to content

Commit c750931

Browse files
committed
testing
1 parent 279bf60 commit c750931

File tree

1 file changed

+51
-4
lines changed

1 file changed

+51
-4
lines changed

TESTING.md

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Getting the Latest Dev Version
44

5-
The `dev` branch has all the new cool stuff that needs testing before we merge it to `master`. Here's how you grab it:
5+
The `dev` branch has all the new cool stuff that needs testing before we merge it to `rc`. It's where we test new features, bug fixes, and stability before releasing.
66

77
### Setting Up Dev Branch
88

@@ -22,7 +22,7 @@ The `dev` branch has all the new cool stuff that needs testing before we merge i
2222

2323
#### Already have the repo?
2424

25-
1. Make sure main is current:
25+
1. Make sure master is current branch:
2626

2727
```bash
2828
git checkout master
@@ -65,6 +65,48 @@ Just follow the README.md or use the install script:
6565
t : [t]est run without executing (-irst to dry run all)
6666
```
6767

68+
## Testing the Release Candidate (RC) Branch
69+
70+
The `rc` (release-candidate) branch is used for final testing and bug fixes before a new release. During Freeze Week, only bug fixes and stabilization are allowed in `rc`—no new features. Testing on `rc` helps ensure a stable release.
71+
72+
### Checking Out the RC Branch
73+
74+
#### First-timers:
75+
76+
1. Clone the repo (if you haven't already):
77+
78+
```bash
79+
git clone https://github.com/HyDE-Project/HyDE.git
80+
cd HyDE
81+
```
82+
83+
2. Switch to the rc branch:
84+
```bash
85+
git checkout rc
86+
```
87+
88+
#### Already have the repo?
89+
90+
1. Make sure your repo is up to date:
91+
92+
```bash
93+
git checkout master
94+
git pull
95+
```
96+
97+
2. Fetch and switch to the latest rc branch:
98+
```bash
99+
git fetch origin rc
100+
git checkout rc
101+
git pull origin rc
102+
```
103+
104+
### Running the RC Version
105+
106+
Follow the same steps as for `dev` (see above) to install and test. Focus on finding bugs and verifying stability—no new features should be present in `rc`.
107+
108+
> **Note:** If you find a bug in `rc`, report it right away so it can be fixed before release! See the reporting section below.
109+
68110
## What to Test
69111

70112
Look out for:
@@ -103,9 +145,14 @@ Found something weird? Here's what to do:
103145

104146
### GitHub (Preferred)
105147

106-
Report directly on the dev-to-master PR:
148+
Report directly on the rc to master MR:
149+
150+
- Go here: https://github.com/HyDE-Project/HyDE/compare/master...rc
151+
152+
Report directly on the dev to rc MR:
153+
154+
- Go here: https://github.com/HyDE-Project/HyDE/compare/dev...rc
107155

108-
- Go here: https://github.com/HyDE-Project/HyDE/compare/master...automated-dev-to-master-branch
109156

110157
### Discord
111158

0 commit comments

Comments
 (0)