Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 1.98 KB

Contributing to the DevKit CLI plugin

Thank you for your interest in contributing to the DevKit CLI plugin! All contributions are welcome. This guide will help you get started with the development process.

Getting started

Prerequisites

Before you begin, make sure you have the Shopify CLI installed on your system.

Installation

Follow these steps to set up the plugin for local development:

  1. Install the Shopify CLI (if you haven't already):
# On macOS using npm
npm install -g @shopify/cli@latest

# On macOS using Homebrew
brew tap shopify/shopify
brew install shopify-cli

# For other platforms, see the Shopify CLI documentation
  1. Clone the repository:
# Clone to your preferred location
cd ~/projects
git clone https://github.com/archetype-themes/plugin-devkit.git
  1. Link your local copy to the Shopify CLI:
cd plugin-devkit
shopify plugins link

This will allow you to test your changes locally before submitting them.

Development workflow

  1. Find or create an issue in the GitHub Issues section
  2. Assign yourself to the issue you're working on
  3. Create a new branch for your feature or bugfix
  4. Make your changes and test them thoroughly
  5. Submit a pull request targeting the main branch

Uninstalling the plugin

If you need to uninstall the plugin, you can do so with one of these commands:

# From the project directory
cd ~/projects/plugin-devkit
shopify plugins uninstall

# From anywhere
shopify plugins uninstall plugin-devkit

Need help?

If you have questions or need assistance:

  1. Check the existing documentation
  2. Comment on the relevant GitHub issue
  3. Reach out to the maintainers through the project's communication channels

We appreciate your contributions and look forward to your pull requests!