🤝 Contribution Guide

Thank you for your interest in contributing! 🎉

📋 Ways to Contribute

📝

Add new scripts

Create useful scripts for server/PC administration

🐛

Fix bugs

Fix issues in scripts or website

📚

Improve documentation

Fix or add documentation

🌐

Translate

Help translate to other languages

🔍

Report bugs

Create issues for bugs found

🚀 Adding New Scripts

Step 1: Create Script File

Create file in public/run/<category>/

Linux (.sh) Windows (.ps1)

#!/bin/bash
SCRIPT_NAME="Nama Script"
SCRIPT_DESC="Deskripsi script"
SCRIPT_VERSION="1.0.0"

# ... helper functions ...

main() {
  print_info
  confirm_run
  print_banner
  
  # Logic script kamu di sini
  
  print_credits
}

main

Step 2: Register in Registry

Edit src/data/tools.ts

{
  id: 'nama-script',
  name: { id: 'Nama Script', en: 'Script Name' },
  description: { id: 'Deskripsi', en: 'Description' },
  category: 'system',
  platforms: ['linux', 'windows'],
  usage: {
    linux: 'curl -fsSL sh.pages.dev/run/system/nama.sh | bash',
    windows: 'irm sh.pages.dev/run/system/nama.ps1 | iex',
  },
  features: { id: ['Fitur 1'], en: ['Feature 1'] },
}

Step 3: Update Interactive Menu

Add entry in start.sh and start.ps1

📁 Project Structure

public/run/
├── lib/           # Shared libraries
├── system/        # System scripts
├── network/       # Network scripts
├── security/      # Security scripts
├── utility/       # Utility scripts
├── start.sh       # Menu (Linux)
└── start.ps1      # Menu (Windows)

src/
├── components/    # UI components
├── data/          # Script registry
├── i18n/          # Translations
├── layouts/       # Page layouts
└── pages/         # Web pages

💻 Development Setup

# Clone repository
git clone https://github.com/user/script-toolbox.git
cd script-toolbox

# Install dependencies
npm install

# Start development server
npm run dev

📤 Pull Request Guidelines

Fork - Fork this repository
Branch - Create a branch for your feature/fix: git checkout -b feat/nama-fitur
Commit - Commit your changes: git commit -m "feat: tambah script xyz"
Push - Push to branch: git push origin feat/nama-fitur
PR - Create Pull Request

Commit Message Format

feat: New feature fix: Bug fix docs: Documentation refactor: Refactoring

PR Checklist

Script runs without errors
Follows standard template
Registered in tools.ts
Added to interactive menu
Description available in 2 languages (ID/EN)

⚖️ Code of Conduct

Be respectful to other contributors
Focus on quality and usefulness of scripts
Do not submit harmful or malicious scripts
Document scripts clearly

Thank you for contributing! 🙏

View on GitHub