Typical Workflow

Learn the recommended workflow for using Paplix with your KiCad projects.

Overview

The typical workflow follows these steps:

  1. Clone - Get the project from Paplix
  2. Work - Make changes in KiCad
  3. Sync - Push your changes
  4. Review - Create a merge request for team review

Step-by-Step Guide

1. Clone a Project

  1. Open KiCad
  2. Click Paplix → Clone Project
  3. Select the repository from your Paplix account
  4. Choose a local directory for the project
  5. Click Clone

The project files will be downloaded and ready to open.

2. Make Changes

Work on your design as usual in KiCad:

  • Edit schematics
  • Modify PCB layout
  • Update component values
  • Add or remove parts

The plugin automatically tracks all changes to KiCad files.

3. View Changes

Before syncing, review what you've changed:

  1. Click Paplix → View Changes
  2. See a list of modified files
  3. For KiCad files, see a visual diff of component changes

4. Sync Changes

Push your changes to Paplix:

  1. Click Paplix → Sync
  2. Enter a commit message describing your changes
  3. Click Push

Your changes are now saved and visible in the Paplix web app.

5. Create a Merge Request

When ready for team review:

  1. Go to your project on paplix.io
  2. Navigate to Merge Requests → New
  3. Select your branch and target branch
  4. Add a description and create the merge request

Best Practices

Commit Often

Make small, frequent commits rather than large infrequent ones. This makes it easier to:

  • Track what changed and when
  • Revert specific changes if needed
  • Resolve conflicts with teammates

Write Good Commit Messages

Describe what changed and why:

  • Good: "Add decoupling capacitors to U3"
  • Bad: "Updated schematic"

Review Before Pushing

Always use View Changes before syncing to verify you're pushing the right changes.

Create Branches for Features

For larger changes, work on a separate branch:

  1. Click Paplix → Create Branch
  2. Name it descriptively (e.g., add-usb-controller)
  3. Make your changes
  4. Create a merge request when ready

Next Steps