Skip to main content
Welcome to the WordPress Developer Showcase project! This guide will help you get set up and make your first contribution.

​
Prerequisites

Before you begin, ensure you have the following installed:
  • WordPress 6.9 or higher
  • PHP 8.0+ (project uses PHP 8.1+)
  • Node.js 18+ for development
  • npm or yarn package manager
  • Git for version control
  • Composer for PHP dependency management

​
Fork and Clone the Repository

1

Fork the repository

Visit the WordPress Developer Showcase repository and click the Fork button in the top-right corner to create your own copy.
2

Clone your fork

Clone your forked repository to your local machine:
git clone https://github.com/YOUR-USERNAME/wordpress-developer-showcase.git
cd wordpress-developer-showcase
3

Add upstream remote

Add the original repository as an upstream remote to keep your fork in sync:
git remote add upstream https://github.com/ORIGINAL-OWNER/wordpress-developer-showcase.git
git fetch upstream

​
Repository Structure

The root of this repository represents the wp-content directory: 
├── themes/
│   └── bifrost-noise/        # Main theme
├── plugins/
│   └── bifrost-music/        # Music plugin
├── CONTRIBUTING.md
└── README.md
This structure reflects a WordPress installation’s content directory, making it easy to understand where your changes will live in production.

​
Set Up Development Environment

1

Install PHP dependencies

If you’re working on a theme or plugin with a composer.json file:
# For the theme
cd themes/bifrost-noise
composer dev

# Or for the plugin
cd plugins/bifrost-music
composer dev
2

Install Node dependencies

If working with JavaScript/CSS build tools:
# In the theme or plugin directory
npm install
3

Set up WordPress

You’ll need a local WordPress installation. The repository contents should be placed in or symlinked to your WordPress wp-content directory.

​
Understanding the Branches

This project uses a simplified Git Flow approach with two main branches:
BranchPurposeDeploys To
trunkProduction-ready code (primary branch)Production
stagingIntegration branch for testingStaging Environment
IMPORTANT: staging is NEVER merged into trunk. The staging branch is only used for testing. When changes are approved, the original working branch is merged directly into trunk.

​
Syncing Your Fork

Before starting new work, always sync your fork with the upstream repository: 
# Switch to trunk and pull latest changes
git checkout trunk
git pull upstream trunk

# Push updates to your fork
git push origin trunk
Keep your trunk branch clean and always create new branches from an up-to-date trunk.

​
Creating Your First Branch

When you’re ready to start working: 
# Ensure you're on trunk and it's up to date
git checkout trunk
git pull upstream trunk

# Create a new branch with the appropriate prefix
git checkout -b feature/your-feature-name
See the Workflow page for detailed information about branch naming and the contribution process.

​
Getting Help

If you have questions:

Open an Issue

Open an issue with the question label for general questions about contributing.

Contact Maintainers

Reach out to the project maintainers for specific guidance.

​
Next Steps

Now that you’re set up:
  1. Read the Workflow Guide to understand the Git flow
  2. Review the Coding Standards before writing code
  3. Start contributing!
Remember: All contributions are welcome, from bug fixes to new features to documentation improvements!

Build docs developers (and LLMs) love

Get started for freeTalk to us