Prispievanie

Ďakujeme, že máte záujem prispievať do BentoPDF! Táto príručka vám pomôže začať.

Začíname

Predpoklady

• Node.js 18+
• npm 9+
• Git

Nastavenie

# Fork and clone the repository
git clone https://github.com/YOUR_USERNAME/bentopdf.git
cd bentopdf

# Install dependencies
npm install

# Start development server
npm run dev

Štruktúra projektu

bentopdf/
├── src/
│   ├── js/
│   │   ├── config/       # Tool definitions
│   │   ├── logic/        # Tool page logic
│   │   ├── utils/        # Shared utilities
│   │   └── ui.ts         # UI helpers
│   ├── pages/            # Tool HTML pages
│   └── css/              # Styles
├── public/
│   ├── locales/          # Translations
│   └── pymupdf-wasm/     # WASM modules
├── docs/                 # Documentation (VitePress)
└── scripts/              # Build scripts

Pridanie nového nástroja

Krok 1: Vytvorte súbor s logikou

Vytvorte src/js/logic/your-tool-page.ts:

import { showLoader, hideLoader, showAlert } from '../ui.js';
import { state } from '../state.js';

document.addEventListener('DOMContentLoaded', () => {
  // Your tool logic here
});

Krok 2: Vytvorte HTML stránku

Vytvorte src/pages/your-tool.html podľa existujúcich šablón nástrojov.

Krok 3: Zaregistrujte nástroj

Pridajte do src/js/config/tools.ts:

{
  href: import.meta.env.BASE_URL + 'your-tool.html',
  name: 'Your Tool',
  icon: 'ph-icon-name',
  subtitle: 'Description of your tool.',
}

Krok 4: Pridajte do konfigurácie buildu

Pridajte stránku do vite.config.ts:

'your-tool': resolve(__dirname, 'src/pages/your-tool.html'),

Krok 5: Pridajte preklady

Pridajte záznamy do všetkých jazykových súborov v public/locales/:

{
  "yourTool": {
    "name": "Your Tool",
    "subtitle": "Description"
  }
}

Štýl kódu

• Pre všetok nový kód používajte TypeScript
• Dodržiavajte existujúce vzory pre konzistentnosť
• Pred odoslaním zmien spustite npm run format
• Žiadne komentáre v produkčnom kóde (komentáre sa pri builde odstraňujú)

Postup pre pull request

1. Vytvorte vetvu funkcie: git checkout -b feature/your-feature
2. Vykonajte zmeny
3. Dôkladne otestujte: npm run build
4. Odošlite PR s jasným popisom

Preklady

Pozrite si TRANSLATION.md, kde nájdete postup pridania nových jazykov.

Licenčná zmluva prispievateľa

Skôr než bude váš PR zlúčený, budete musieť podpísať našu CLA:

• Individuálna CLA (ICLA)
• Firemná CLA (CCLA)

Pomoc

• GitHub Issues
• Komunita na Discorde

Licencia

BentoPDF má duálnu licenciu:

• AGPL-3.0 pre open-source projekty, v ktorých verejne zdieľate celý zdrojový kód
• Komerčná licencia pre proprietárne aplikácie so zatvoreným zdrojovým kódom - Získajte doživotnú licenciu za $79

Prispievaním súhlasíte s tým, že vaše príspevky budú licencované za týchto podmienok.