Skip to content

Latest commit

 

History

History
88 lines (51 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

88 lines (51 loc) · 2.52 KB

Contributing to Storefront Next Template

Thank you for your interest in contributing! 🎉

⚠️ Important: This is a Mirror Repository

This repository is automatically synchronized from our monorepo and is read-only.

All contributions must be made to the monorepo, not here.

How to Contribute

Step 1: Visit the Monorepo

All development happens in the monorepo:

SalesforceCommerceCloud/storefront-next

Step 2: Read the Monorepo Contributing Guidelines

The monorepo has detailed contribution guidelines:

Monorepo CONTRIBUTING.md

Step 3: Submit Your PR to the Monorepo

  1. Fork the monorepo (not this mirror repo)
  2. Create a branch for your changes
  3. Make your changes in packages/template-retail-rsc-app/
  4. Submit PR to the monorepo
  5. Your changes will automatically sync to this mirror repo

Why Can't I Contribute Here?

This repository is a mirror of the template from the monorepo:

  • 🔒 Read-only: This repo is protected against direct changes
  • 🔄 Automatic sync: Changes are overwritten by automatic syncs
  • ❌ Changes lost: Any direct changes would be lost on next sync
  • ✅ Single source: Keeps monorepo as single source of truth

What If I Found a Bug?

Option 1: Open Issue in Monorepo (Preferred)

Open an issue in the monorepo with details:

Open Issue in Monorepo

Option 2: Submit a Fix via PR

Follow the steps above to submit a PR to the monorepo.

Repository Structure

This mirror repository contains only the storefront template.

The monorepo contains:

  • 📦 packages/template-retail-rsc-app/ (this template)
  • 📦 packages/storefront-next-dev/ (dev tooling)
  • 📦 Other packages and tools
  • 📋 Comprehensive documentation
  • 🧪 Full test suite

Questions?

  • General questions: Open a discussion in the monorepo
  • Bug reports: Open an issue in the monorepo
  • Feature requests: Open an issue in the monorepo

Thank You!

We appreciate your contributions! 🙏

By contributing to the monorepo, you help all users of the Storefront Next platform.