docs: Add branch structure documentation for v14 workflow
This commit is contained in:
184
BRANCH-STRUCTURE.md
Normal file
184
BRANCH-STRUCTURE.md
Normal file
@@ -0,0 +1,184 @@
|
||||
# ⚠️ RR3 APK Repository - Branch Structure
|
||||
|
||||
**Date:** February 22, 2026
|
||||
**Active Branch:** v14
|
||||
|
||||
---
|
||||
|
||||
## 📋 Default Branch
|
||||
|
||||
**`v14` is the default and primary development branch**
|
||||
|
||||
All work on the RR3 Community Edition APK should be done on the `v14` branch.
|
||||
|
||||
---
|
||||
|
||||
## 🌿 Branch Overview
|
||||
|
||||
### Active Branches
|
||||
|
||||
**v14** (DEFAULT) ⭐
|
||||
- Primary development branch
|
||||
- RR3 version 14.0.1 (EA latest before community)
|
||||
- Contains all community modifications:
|
||||
- Killswitch removal
|
||||
- Custom server support
|
||||
- Server browser/selection
|
||||
- Settings menu additions
|
||||
- Server URL input dialog (NEW)
|
||||
- **All new features go here**
|
||||
|
||||
**main**
|
||||
- Legacy/documentation branch
|
||||
- Contains initial project documentation
|
||||
- Not actively developed
|
||||
|
||||
**killswitch-killer**
|
||||
- Documentation-focused branch
|
||||
- Contains killswitch removal guide
|
||||
- Code duplicated to v14
|
||||
- Primarily for community reference
|
||||
|
||||
**discord-apktool** / **discord-community**
|
||||
- Experimental/test branches
|
||||
- Not actively maintained
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Workflow
|
||||
|
||||
### Starting New Work
|
||||
|
||||
```bash
|
||||
# 1. Switch to v14
|
||||
cd E:\rr3\rr3-apk
|
||||
git checkout v14
|
||||
|
||||
# 2. Pull latest changes
|
||||
git pull origin v14
|
||||
git pull gitea v14
|
||||
|
||||
# 3. Verify you're on v14
|
||||
git branch
|
||||
# Should show: * v14
|
||||
|
||||
# 4. Start working...
|
||||
```
|
||||
|
||||
### Committing Changes
|
||||
|
||||
```bash
|
||||
# 1. Stage changes
|
||||
git add .
|
||||
|
||||
# 2. Commit with descriptive message
|
||||
git commit -m "feat: Your feature description"
|
||||
|
||||
# 3. Push to both remotes (v14 branch)
|
||||
git push origin v14
|
||||
git push gitea v14
|
||||
```
|
||||
|
||||
### Checking Current Branch
|
||||
|
||||
```bash
|
||||
# Quick check
|
||||
git branch
|
||||
|
||||
# Detailed check with remotes
|
||||
git branch -vv
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Branch Comparison
|
||||
|
||||
| Branch | Purpose | Status | Use Case |
|
||||
|--------|---------|--------|----------|
|
||||
| **v14** | Primary development | ✅ Active | All new features |
|
||||
| main | Documentation | ⚠️ Legacy | Reference only |
|
||||
| killswitch-killer | Killswitch docs | 📚 Reference | Community FAQ |
|
||||
| discord-* | Experiments | ⏸️ Paused | Testing only |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Recent Commits on v14
|
||||
|
||||
```
|
||||
51be1177d - feat: Add first-launch server URL input dialog
|
||||
b7fb41dd0 - Add CORRECTED custom server configuration guide
|
||||
240773d28 - Add SSL certificate validation analysis
|
||||
d9eec8c69 - Add technical documentation for Nimble SDK killswitch removal
|
||||
43a74d365 - Add comprehensive Getting Started guide
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✅ Current State (v14 Branch)
|
||||
|
||||
**Features Implemented:**
|
||||
- ✅ Killswitch removal (bypasses EA version check)
|
||||
- ✅ Custom server URL support (AndroidManifest.xml)
|
||||
- ✅ SSL certificate flexibility (self-signed certs work)
|
||||
- ✅ Server browser UI (optional)
|
||||
- ✅ Settings menu with server options
|
||||
- ✅ **Server URL input dialog (LATEST)** - First-launch configuration
|
||||
|
||||
**Next Steps:**
|
||||
- Sign and test server URL input feature
|
||||
- Test on physical device/emulator
|
||||
- Add "Change Server" to settings menu
|
||||
- Implement server favorites list
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Syncing Between Remotes
|
||||
|
||||
The v14 branch is synced to both remotes:
|
||||
|
||||
**GitHub:** https://github.com/supermegamestre/Project-Real-Resurrection-3
|
||||
**Gitea:** https://gitea.barrer.net/project-real-resurrection-3/rr3-apk
|
||||
|
||||
```bash
|
||||
# Push to both remotes at once
|
||||
git push origin v14 && git push gitea v14
|
||||
|
||||
# Pull from both (if needed)
|
||||
git pull origin v14
|
||||
git pull gitea v14
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 Best Practices
|
||||
|
||||
1. **Always work on v14** - Never commit directly to main
|
||||
2. **Pull before starting** - Get latest changes first
|
||||
3. **Test before pushing** - Build APK and verify it compiles
|
||||
4. **Push to both remotes** - Keep GitHub and Gitea in sync
|
||||
5. **Descriptive commits** - Use conventional commit format
|
||||
|
||||
**Conventional Commit Format:**
|
||||
```
|
||||
feat: Add new feature
|
||||
fix: Fix a bug
|
||||
docs: Update documentation
|
||||
refactor: Refactor code
|
||||
test: Add tests
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Remember
|
||||
|
||||
**v14 is your home base. All community work happens here.** 🏠
|
||||
|
||||
When in doubt:
|
||||
```bash
|
||||
git checkout v14
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** February 22, 2026
|
||||
**Current HEAD (v14):** 51be1177d
|
||||
Reference in New Issue
Block a user