Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (51 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

65 lines (51 loc) · 1.22 KB

Contributing to cpyurl

Development Setup

Prerequisites

  • Node.js v22 or higher
  • npm or pnpm package manager

Installation

  1. Clone the repository
git clone https://github.com/DavidNiessen/cpyurl.git
cd cpyurl
  1. Install dependencies
npm install
# or
pnpm install
  1. Build the extension
npm run build
# or
pnpm build
  1. Load the extension in Chrome
    • Navigate to chrome://extensions/
    • Enable "Developer mode"
    • Click "Load unpacked"
    • Select the dist folder

Project Structure

cpyurl/
├── src/
│   ├── background/       # Background service worker
│   ├── notification/     # Notification system
│   └── index.ts         # Core URL copying logic
├── static/
│   ├── assets/          # Icons and images
│   └── manifest.json    # Chrome extension manifest
└── dist/                # Build output (generated)

Code Quality

  • TypeScript strict mode is enabled
  • All async operations have proper error handling
  • Chrome API types are used throughout

Building for Release

npm run build:bundle
# or
pnpm build:bundle

This creates a cpyurl.zip file in the dist folder ready for distribution.