101 lines
2.7 KiB
Markdown
101 lines
2.7 KiB
Markdown
# Backlog
|
|
|
|
zig version: 0.15.1
|
|
|
|
Backlog Labs Game Engine.
|
|
|
|
## Getting Started
|
|
|
|
run tools/scripts/first-time-setup.py
|
|
|
|
ffmpeg -i INPUT.mp4 -c:v libtheora -q:v 7 -c:a libvorbis -q:a 4 OUTPUT.ogv
|
|
|
|
## git-bug Cheat Sheet
|
|
|
|
This project uses git-bug for distributed issue tracking. Issues are stored directly in the repository.
|
|
|
|
### Common Commands
|
|
|
|
**Listing Issues**
|
|
```bash
|
|
git bug bug # List all issues
|
|
git bug bug status:open # List only open issues
|
|
git bug bug status:closed # List only closed issues
|
|
```
|
|
|
|
**Creating Issues**
|
|
```bash
|
|
git bug bug new -t "title" -m "message" # Create new issue
|
|
git bug bug new -t "Add feature X" -m "Description" # Example
|
|
```
|
|
|
|
**Viewing & Managing Issues**
|
|
```bash
|
|
git bug bug show <id> # Show issue details
|
|
git bug bug comment <id> # Add a comment to an issue
|
|
git bug bug close <id> # Close an issue
|
|
git bug bug open <id> # Reopen an issue
|
|
git bug bug status <id> # Show issue status
|
|
```
|
|
|
|
**Labels**
|
|
```bash
|
|
git bug bug label <id> # Show labels for an issue
|
|
git bug bug label new <id> <label> # Add a label
|
|
git bug bug label rm <id> <label> # Remove a label
|
|
```
|
|
|
|
**Syncing**
|
|
```bash
|
|
git bug pull # Pull issue updates from remote
|
|
git bug push # Push issue updates to remote
|
|
```
|
|
|
|
### Standard Labels
|
|
|
|
**Component Labels**: `core`, `rendering`, `physics`, `build-system`, `platform`, `assets`, `audio`, `ui`, `documentation`
|
|
|
|
**Type Labels**:
|
|
- `bug` - Defects or incorrect behavior
|
|
- `feature` - New functionality
|
|
- `enhancement` - Improvements to existing features
|
|
- `task` - General development work
|
|
- `documentation` - Documentation improvements
|
|
- `question` - Design decisions or discussions
|
|
- `refactoring` - Code cleanup
|
|
|
|
**Problem Type Labels** (for bugs):
|
|
- `memory` - Memory issues
|
|
- `threading` - Concurrency issues
|
|
- `crash` - Application crashes
|
|
- `build` - Build system issues
|
|
|
|
### Quick Examples
|
|
|
|
```bash
|
|
# Create a bug report
|
|
git bug bug new -t "Memory leak in asset loader" -m "Assets not freed when unloading scenes"
|
|
git bug bug label new <id> bug assets memory
|
|
|
|
# Create a feature request
|
|
git bug bug new -t "Add terrain generation" -m "Implement heightmap-based terrain"
|
|
git bug bug label new <id> feature rendering
|
|
|
|
# Create a task
|
|
git bug bug new -t "Update to Zig 0.15" -m "Migrate to latest Zig version"
|
|
git bug bug label new <id> task build-system
|
|
|
|
# View and comment on an issue
|
|
git bug bug show abc123
|
|
git bug bug comment abc123
|
|
```
|
|
|
|
### Tips
|
|
|
|
- Issue IDs can be abbreviated (first few characters)
|
|
- Use `--non-interactive` flag for scripting
|
|
- Issues sync with `git bug pull/push`
|
|
- Keep descriptions factual and clear
|
|
|
|
|