Skip to content

[WIP] Roll up P4X-ng/PhoenixBoot reviews and tickets #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
P4X-ng merged 3 commits into from
Mar 17, 2026
Merged

[WIP] Roll up P4X-ng/PhoenixBoot reviews and tickets #124

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac37a7f
Initial plan
Copilot Dec 29, 2025
966f6f4
Changes before error encountered
Copilot Dec 29, 2025
220e079
Merge remote-tracking branch 'github/main' into work-124
mohibulahmed Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Thank you for your interest in contributing to PhoenixBoot! This document provid
### Prerequisites

- Python 3.8 or higher
- Docker or Podman (for container-based workflows)
- Podman (for container-based workflows)
- Git
- QEMU (for testing UEFI components)
- EDK2 toolchain (for UEFI firmware development)
Expand All @@ -20,12 +20,17 @@ Thank you for your interest in contributing to PhoenixBoot! This document provid
cd PhoenixBoot
```

2. Install Python dependencies:
2. If you are contributing from a fork, add the main repository as `upstream`:
```bash
git remote add upstream https://github.com/P4X-ng/PhoenixBoot.git
```

3. Install Python dependencies:
```bash
pip install -r requirements.txt
```

3. Verify your setup:
4. Verify your setup:
```bash
./pf.py --help
```
Expand All @@ -35,6 +40,7 @@ Thank you for your interest in contributing to PhoenixBoot! This document provid
### Reporting Bugs

Before creating a bug report, please check existing issues to avoid duplicates.
Use the bug report template when it fits the issue.

When reporting a bug, include:
- A clear and descriptive title
Expand All @@ -52,8 +58,12 @@ Enhancement suggestions are welcome! Please include:
- Any potential drawbacks or implementation challenges
- Mock-ups or examples if applicable

Use the feature request template when it fits the proposal.

### Pull Requests

For significant changes, open or reference an issue first so the direction is clear before you start.

1. **Create a branch** for your changes:
```bash
git checkout -b feature/your-feature-name
Expand Down Expand Up @@ -87,6 +97,12 @@ Enhancement suggestions are welcome! Please include:
git push origin feature/your-feature-name
```

6. **Before opening the pull request, verify the checklist**:
- Tests added or updated when behavior changed
- Documentation updated where needed
- Security-sensitive changes clearly called out
- No merge conflicts with the current `main` branch

## 🎨 Code Style

### Python Code
Expand Down Expand Up @@ -126,7 +142,7 @@ pytest tests/ -m integration
./pf.py workflow-test-uuefi

# Container-based tests
docker-compose --profile test up
podman compose --profile test up
```

### Writing Tests
Expand Down
Loading