|
| 1 | +# Testers Guide |
| 2 | + |
| 3 | +## Getting the Latest Dev Version |
| 4 | + |
| 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: |
| 6 | + |
| 7 | +### Setting Up Dev Branch |
| 8 | + |
| 9 | +#### First-timers: |
| 10 | + |
| 11 | +1. Clone it: |
| 12 | + |
| 13 | + ```bash |
| 14 | + git clone https://github.com/HyDE-Project/HyDE.git |
| 15 | + cd HyDE |
| 16 | + ``` |
| 17 | + |
| 18 | +2. Switch to dev: |
| 19 | + ```bash |
| 20 | + git checkout dev |
| 21 | + ``` |
| 22 | + |
| 23 | +#### Already have the repo? |
| 24 | + |
| 25 | +1. Make sure main is current: |
| 26 | + |
| 27 | + ```bash |
| 28 | + git checkout master |
| 29 | + git pull |
| 30 | + ``` |
| 31 | + |
| 32 | +2. Get the dev goodies: |
| 33 | + ```bash |
| 34 | + git fetch origin dev |
| 35 | + git checkout dev |
| 36 | + git pull origin dev |
| 37 | + ``` |
| 38 | + |
| 39 | +### Running Dev Version |
| 40 | + |
| 41 | +Just follow the README.md or use the install script: |
| 42 | + |
| 43 | +1. Full install: |
| 44 | + |
| 45 | + ```bash |
| 46 | + ./install.sh |
| 47 | + ``` |
| 48 | + |
| 49 | +2. Just restore dotfiles: |
| 50 | + |
| 51 | + ```bash |
| 52 | + ./install.sh -r |
| 53 | + ``` |
| 54 | + |
| 55 | +3. Other cool stuff you can do: |
| 56 | + ```bash |
| 57 | + Usage: ./install.sh [options] |
| 58 | + i : [i]nstall hyprland without configs |
| 59 | + d : install hyprland [d]efaults without configs --noconfirm |
| 60 | + r : [r]estore config files |
| 61 | + s : enable system [s]ervices |
| 62 | + n : ignore/[n]o [n]vidia actions |
| 63 | + h : re-evaluate S[h]ell |
| 64 | + m : no the[m]e reinstallations |
| 65 | + t : [t]est run without executing (-irst to dry run all) |
| 66 | + ``` |
| 67 | + |
| 68 | +## What to Test |
| 69 | + |
| 70 | +Look out for: |
| 71 | + |
| 72 | +1. **New Features**: Break 'em if you can |
| 73 | +2. **UI Elements**: Do they look right? Work right? |
| 74 | +3. **Theme Switching**: Dark/light mode working? |
| 75 | +4. **Wallpapers**: Can you add/remove/switch? |
| 76 | +5. **System Features**: Notifs, settings working? |
| 77 | +6. **Stability**: Any crashes or freezes? |
| 78 | +7. **Different Systems**: Test on whatever hardware you've got |
| 79 | + |
| 80 | +## Testing Goals |
| 81 | + |
| 82 | +### Focus On |
| 83 | + |
| 84 | +- **Isolated Issues**: Pinpoint exactly where stuff breaks |
| 85 | +- **Regression**: Make sure we didn't break old fixes |
| 86 | +- **UX**: Tell us if something feels clunky |
| 87 | +- **Performance**: Spot any lag or resource hogs |
| 88 | + |
| 89 | +### For Our Trusted Testers |
| 90 | + |
| 91 | +As a trusted tester, you're extra special: |
| 92 | + |
| 93 | +- You get quick answers when you report stuff |
| 94 | +- Your ideas go to the top of the pile |
| 95 | +- Just say what you think - no filter needed |
| 96 | +- Help us shape features before everyone else sees them |
| 97 | + |
| 98 | +We'll get back to you fast so we can fix things quicker! |
| 99 | + |
| 100 | +## How to Report Issues |
| 101 | + |
| 102 | +Found something weird? Here's what to do: |
| 103 | + |
| 104 | +### GitHub (Preferred) |
| 105 | + |
| 106 | +Report directly on the dev-to-master PR: |
| 107 | + |
| 108 | +- Go here: https://github.com/HyDE-Project/HyDE/compare/master...automated-dev-to-master-branch |
| 109 | + |
| 110 | +### Discord |
| 111 | + |
| 112 | +In the HyDE Discord: |
| 113 | + |
| 114 | +- Drop a message in #testers channel |
| 115 | +- Real issues should go on GitHub, but we can chat about them in Discord |
| 116 | + |
| 117 | +### Making Good Bug Reports |
| 118 | + |
| 119 | +Just follow the [issue templates](.github/ISSUE_TEMPLATE) |
| 120 | + |
| 121 | +## Release Schedule |
| 122 | + |
| 123 | +Check the [release policy](./RELEASE_POLICY.md) |
| 124 | + |
| 125 | +## Community Stuff |
| 126 | + |
| 127 | +Nobody gets paid for this - we're all just nerds who like making cool stuff together. Your help testing is super valuable! Everyone's contribution matters, whether it's testing, bug reports, code, or just ideas. |
| 128 | + |
| 129 | +Let's build something awesome together! Thanks for being part of our weird little community! |
| 130 | + |
| 131 | +### Do not forget stay HyDErated! |
0 commit comments