Contributing to SnapRun

Thank you for your interest in contributing to SnapRun! This document provides guidelines and information for contributors to help make the process smooth and effective.

🌟 Ways to Contribute

🐛 Report Bugs

Use GitHub Issues to report bugs
Search existing issues before creating new ones
Provide detailed reproduction steps
Include system information and SnapRun version

💡 Suggest Features

Use GitHub Discussions for feature ideas
Explain the use case and benefits
Consider implementation complexity
Gather community feedback

📝 Improve Documentation

Fix typos and clarify instructions
Add examples and tutorials
Update API documentation
Create user guides and walkthroughs

🔧 Submit Code

Bug fixes and improvements
New Rhai functions and APIs
UI enhancements
Performance optimizations

🎯 Create Scripts

Example scripts for common tasks
Educational scripts for learning Rhai
Template scripts for different use cases
Advanced automation examples

🚀 Getting Started

Prerequisites

Required Tools:

Rust (latest stable version)
Node.js (LTS version)
pnpm (recommended) or npm
Git

Optional Tools:

Visual Studio Code with Rust extensions
Inno Setup for building installers

Setting Up Development Environment

Fork and Clone

git clone https://github.com/yourusername/winscript.git
cd winscript

Install Dependencies

# Frontend dependencies
pnpm install

# Rust dependencies (automatically handled by Cargo)
cd src-tauri
cargo check

Run Development Server
```
# From project root
pnpm tauri dev
```
Verify Installation
- Application should open with hot-reload enabled
- Changes to frontend code should reflect immediately
- Changes to Rust code require restart

Project Structure

SnapRun/
├── src/                    # React/TypeScript frontend
│   ├── components/         # React components
│   ├── hooks/             # Custom React hooks
│   ├── services/          # Frontend services
│   └── ThemedComponents/  # UI component library
├── src-tauri/             # Rust backend
│   ├── src/
│   │   ├── lib.rs         # Main application logic
│   │   ├── script_manager.rs # Script handling
│   │   ├── fs_kit.rs      # File system operations
│   │   ├── process_kit.rs # Process management
│   │   └── rhai_engine.rs # Rhai integration
│   └── Cargo.toml         # Rust dependencies
├── public/                # Static assets
├── installer/             # Installer resources
└── scripts/               # Built-in example scripts

📋 Contribution Guidelines

Code Style

Rust Code:

Follow Rust style guidelines
Use rustfmt for formatting: cargo fmt
Use clippy for linting: cargo clippy
Write descriptive variable and function names
Add documentation comments for public functions

/// Reads file content and returns it as a string
/// 
/// # Arguments
/// * `file_path` - Path to the file to read
/// 
/// # Returns
/// * `Result<String, String>` - File content or error message
fn read_file_content(file_path: &str) -> Result<String, String> {
    // Implementation
}

TypeScript/React Code:

Use TypeScript for type safety
Follow React best practices
Use functional components with hooks
Use meaningful component and variable names
Add JSDoc comments for complex functions

/**
 * Hook for managing keyboard shortcuts
 * @param shortcuts - Object mapping keys to callback functions
 */
export const useKeyboardShortcuts = (
    shortcuts: Record<string, () => void>
) => {
    // Implementation
};

General Guidelines:

Keep functions small and focused
Use descriptive commit messages
Include tests when appropriate
Update documentation for API changes

Commit Messages

Use clear, descriptive commit messages:

feat: add new file encryption function to Rhai API
fix: resolve system tray icon not updating on Windows 11
docs: update API reference for process management functions
refactor: simplify script loading logic in script_manager
test: add unit tests for file system operations

Format: type: description

Types:

feat: New features
fix: Bug fixes
docs: Documentation changes
style: Formatting changes
refactor: Code restructuring
test: Adding/updating tests
chore: Build process or tooling changes

Pull Request Process

Create Feature Branch

git checkout -b feature/your-feature-name

Make Changes
- Implement your changes
- Test thoroughly
- Update documentation

Test Your Changes

# Run development version
pnpm tauri dev

# Build and test
pnpm tauri build

# Run any tests
cargo test

Create Pull Request
- Push your branch to your fork
- Create PR against main branch
- Fill out PR template completely
- Link related issues
PR Review Process
- Maintainers will review your code
- Address feedback and requested changes
- Keep PR updated with main branch
- PR will be merged when approved

Testing

Manual Testing:

Test on Windows 10 and 11 if possible
Verify system tray functionality
Test global shortcuts
Validate script execution
Check UI responsiveness

Automated Testing:

# Rust tests
cd src-tauri
cargo test

# Frontend tests (if available)
pnpm test

Testing Checklist:

Feature works as expected
No regression in existing functionality
UI is responsive and accessible
System tray and shortcuts work
Scripts execute correctly
Build process completes successfully

🔧 Development Tasks

Adding New Rhai Functions

Define Function in Rust

// In appropriate kit file (fs_kit.rs, process_kit.rs, etc.)
pub fn my_new_function(param: String) -> Result<String, Box<EvalAltResult>> {
    // Implementation
    Ok("result".to_string())
}

Register Function in Rhai Engine

// In rhai_engine.rs
engine.register_fn("my_function", my_new_function);

Update Documentation
- Add function to API_REFERENCE.md
- Include usage examples
- Update FEATURES.md if appropriate

Create Example Script

// In scripts/built_in_scripts/
let result = my_function("test input");
print("Result: " + result);

Improving UI Components

Create/Modify Component

// In src/components/
export const MyComponent: React.FC<Props> = ({ prop1, prop2 }) => {
    return (
        <div className="themed-component">
            {/* Component content */}
        </div>
    );
};

Update Styles

/* In appropriate CSS file */
.themed-component {
    background: var(--glass-background);
    border: 1px solid var(--glass-border);
    border-radius: 8px;
}

Test Responsiveness
- Test different window sizes
- Verify glass effects work
- Check dark theme compatibility

Building Installers

Development Build:

pnpm tauri build

Production Release:

# Build all installer types
pnpm run release:full

Individual Installers:

# MSI installer
pnpm run build:msi

# NSIS installer  
pnpm run build:nsis

# Inno Setup installer
pnpm run build:inno

📚 Resources

Documentation

Tauri Documentation - Framework documentation
Rhai Book - Scripting language reference
React Documentation - Frontend framework
Rust Book - Rust programming language

Tools

Visual Studio Code with extensions:
- Rust Analyzer
- ES7+ React/Redux/React-Native snippets
- Prettier
- GitLens
Rust Playground - Online Rust testing
Rhai Playground - Online Rhai testing

Community

GitHub Discussions - Questions and ideas
GitHub Issues - Bug reports and feature requests
Tauri Discord - Framework support
Rust Community - General Rust help

🛡️ Code of Conduct

Our Standards

Positive behavior includes:

Using welcoming and inclusive language
Being respectful of differing viewpoints
Gracefully accepting constructive criticism
Focusing on what's best for the community
Showing empathy towards other community members

Unacceptable behavior includes:

Harassment, discrimination, or offensive comments
Public or private harassment
Publishing private information without permission
Other conduct inappropriate in a professional setting

Enforcement

Report inappropriate behavior to the project maintainers. All complaints will be reviewed and investigated promptly and fairly.

Project maintainers who don't follow the Code of Conduct may face temporary or permanent consequences.

🏆 Recognition

Contributors are recognized in several ways:

Contributors File

All contributors are listed in CONTRIBUTORS.md with their contributions.

Release Notes

Significant contributions are highlighted in release notes and changelogs.

Special Recognition

First-time contributors get special welcome
Regular contributors may be invited as collaborators
Outstanding contributions are featured in project updates

❓ Getting Help

For Contributors

Read this guide thoroughly
Check existing issues and PRs
Ask questions in GitHub Discussions
Reach out to maintainers for guidance

For Users

Use GitHub Issues for bugs
Use GitHub Discussions for questions
Check FAQ.md for common questions
Review documentation in DOCS.md

📄 License

By contributing to SnapRun, you agree that your contributions will be licensed under the same MIT License that covers the project.

Thank you for contributing to SnapRun! Your efforts help make Windows automation more accessible and powerful for everyone. 🚀

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contributing to SnapRun

🌟 Ways to Contribute

🐛 Report Bugs

💡 Suggest Features

📝 Improve Documentation

🔧 Submit Code

🎯 Create Scripts

🚀 Getting Started

Prerequisites

Setting Up Development Environment

Project Structure

📋 Contribution Guidelines

Code Style

Commit Messages

Pull Request Process

Testing

🔧 Development Tasks

Adding New Rhai Functions

Improving UI Components

Building Installers

📚 Resources

Documentation

Tools

Community

🛡️ Code of Conduct

Our Standards

Enforcement

🏆 Recognition

Contributors File

Release Notes

Special Recognition

❓ Getting Help

For Contributors

For Users

📄 License

FilesExpand file tree

CONTRIBUTING.md

Latest commit

History

CONTRIBUTING.md

File metadata and controls

Contributing to SnapRun

🌟 Ways to Contribute

🐛 Report Bugs

💡 Suggest Features

📝 Improve Documentation

🔧 Submit Code

🎯 Create Scripts

🚀 Getting Started

Prerequisites

Setting Up Development Environment

Project Structure

📋 Contribution Guidelines

Code Style

Commit Messages

Pull Request Process

Testing

🔧 Development Tasks

Adding New Rhai Functions

Improving UI Components

Building Installers

📚 Resources

Documentation

Tools

Community

🛡️ Code of Conduct

Our Standards

Enforcement

🏆 Recognition

Contributors File

Release Notes

Special Recognition

❓ Getting Help

For Contributors

For Users

📄 License