Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
208 lines (170 loc) · 6.55 KB

CONTRIBUTING.md

File metadata and controls

208 lines (170 loc) · 6.55 KB
Raw

Contributing to WooNuxt

First off — thank you! Whether you're fixing a bug, improving docs, adding features, or just giving feedback, you’re helping shape WooNuxt’s future.

This guide explains how to contribute, follow our conventions, and get your pull request merged smoothly.

🏆 Contributors

Listed in order of contribution — based on GitHub stats. Thank you all:

scottyzen
scottyzen 		alexookah
alexookah 		zackha
zackha 		Zielgestalt
Zielgestalt 		brunofullstack
brunofullstack 		tzhf
tzhf 		AlMuz
AlMuz
McRafee
McRafee 		atinux
atinux 		gabrielrbarbosa
gabrielrbarbosa 		danielroe
danielroe 		TomCore
TomCore 		vpashkov
vpashkov 		vernaillen
vernaillen 		arshidkv12
arshidkv12

👉 See full contributor graph →

📦 Looking to Use WooNuxt?

If you're trying to install and use WooNuxt in a project, this file is not for you. Please see the README.md for:

  • Installation instructions
  • Environment setup
  • Usage examples
  • Plugin/module details

This guide is for contributors working on the WooNuxt codebase or documentation.

🛠️ Make Your Changes, Test, Commit, and Push

  1. Fork the repository on GitHub and clone your fork locally:

    git clone https://github.com/YOUR_USERNAME/woonuxt.git
cd woonuxt

  2. Create a new branch using a meaningful name:

    git checkout -b feat/your-feature-name

  3. Make your changes in the appropriate part of the codebase:

    • woonuxt_base/ — Nuxt 3 frontend

  4. Test your changes locally:

    cd woonuxt_base
yarn install
yarn dev

    Then:

    • Open your browser and verify that pages load correctly
    • Interact with cart, product views, and checkout
    • Confirm that WPGraphQL queries resolve properly
    • If modifying the plugin, verify it within the WordPress admin

  5. Stage and commit your changes using Conventional Commits:

    git add .
git commit -m "feat: add custom slot to ProductCard component"

    Common types:

    • feat: — a new feature
    • fix: — a bug fix
    • docs: — documentation-only changes
    • chore: — tooling/config updates
    • style: — non-functional style changes (spacing, formatting, etc.)

  6. Push your branch to GitHub:

    git push origin feat/your-feature-name

  7. Open a Pull Request targeting the master branch. Include:

    • A brief title and description
    • Screenshots or before/after examples (if relevant)
    • Any linked issues or related context

🐛 Reporting Bugs

To report a bug, open a GitHub Issue and include:

  • ✅ What you did
  • ✅ What you expected to happen
  • ✅ What actually happened
  • ✅ WooNuxt, Node, PHP, WordPress, and Nuxt versions
  • ✅ Screenshots, logs, or network errors if helpful

🧭 Questions or Help?

If you're not sure where to start:

Thank you again — WooNuxt gets better because of contributors like you. 💚