Contributing

​

Getting started

git clone https://github.com/YOUR_USERNAME/SlipStreamGUI.git
cd SlipStreamGUI

npm install

git checkout -b feature/your-feature-name

​

Development workflow

​

Making changes

1. Make your changes to the codebase
2. Test your changes thoroughly:
   npm

   npm start  # Test in development mode
   
3. Ensure code quality:
   • Follow existing code style
   • Test on both macOS and Windows if possible
   • Check that the app builds successfully

​

Testing checklist

• App starts without errors
• VPN start/stop functionality works
• System proxy configuration works (if modified)
• No console errors in development mode
• App builds successfully for target platform(s)
• Changes work on both macOS and Windows (if applicable)

​

Building for testing

npm run build:mac

​

Code style

​

JavaScript style

• Indentation: Use 2 spaces (not tabs)
• Semicolons: Use semicolons at the end of statements
• Quotes: Use single quotes for strings (except in JSON)
• Comments: Comment complex logic and non-obvious code
• Functions: Keep functions focused and small
• Naming: Use descriptive variable and function names

​

Example

// Good
function startVpnConnection(domain, dnsResolver) {
  // Validate parameters before starting
  if (!domain || !dnsResolver) {
    console.error('Missing required parameters');
    return false;
  }
  
  // Start the VPN connection
  const result = initializeConnection(domain, dnsResolver);
  return result;
}

// Avoid
function start(d,r){if(!d||!r){return false}return initializeConnection(d,r)}

​

HTML/CSS style

• Use semantic HTML elements
• Keep CSS organized and commented
• Follow existing styling patterns
• Use consistent naming conventions for classes

​

Submitting changes

git commit -m "Add: Description of your changes"

git push origin feature/your-feature-name

​

Pull request guidelines

​

Good pull request title examples

• ✅ “Add DNS checker with parallel testing”
• ✅ “Fix system proxy not clearing on Windows”
• ✅ “Update UI to show connection latency”
• ✅ “Docs: Add troubleshooting section for Linux”

​

Pull request description

1. What changed: Brief summary of changes
2. Why: Reason for the change
3. How to test: Steps to verify the changes
4. Screenshots: If UI changed (before/after)
5. Breaking changes: If any, list them clearly

​

Example pull request

## What changed
Added a DNS health checker that tests multiple DNS servers in parallel.

## Why
Users often don't know which DNS server works best. This feature helps them
find a working DNS server quickly.

## How to test
1. Start the app
2. Click "DNS Checker"
3. Enter test domain and DNS servers
4. Verify parallel testing works
5. Click "Use" on an OK result
6. Verify DNS resolver is set correctly

## Screenshots
[Before/After screenshots]

## Breaking changes
None

​

Reporting issues

​

Required information

• OS version: macOS 13.5, Windows 11, Ubuntu 22.04, etc.
• App version: Check in the app’s About section
• Description: Clear description of the issue
• Steps to reproduce: Numbered steps to reproduce the issue
• Expected behavior: What should happen
• Actual behavior: What actually happens
• Logs: Relevant error messages from the logs panel
• Screenshots: If applicable

​

Example bug report

## Bug: VPN won't start on macOS 14

**OS**: macOS 14.0 (Sonoma)
**App version**: 1.1.0

**Steps to reproduce**:
1. Launch SlipStream GUI
2. Click "Start VPN"
3. Wait 10 seconds

**Expected**: VPN starts and status shows "Running"
**Actual**: Error message "Failed to start client"

**Logs**:

**Screenshots**: [attached]

​

Feature requests

​

Include

1. Use case: Explain why you need this feature
2. Proposed solution: Describe how it should work
3. Alternatives: Other ways to achieve the same goal
4. Additional context: Any relevant information
5. Backward compatibility: Consider existing users

​

Example feature request

## Feature: Auto-reconnect on connection loss

**Use case**:
When the VPN connection drops, users have to manually click "Start VPN"
again. This is inconvenient and interrupts workflow.

**Proposed solution**:
Add an "Auto-reconnect" toggle in settings. When enabled, the app
automatically attempts to reconnect if the connection is lost.

**Alternatives**:
- Manual reconnect (current behavior)
- System-level network monitoring

**Backward compatibility**:
Disabled by default, so existing users won't see changed behavior.

​

Code review process

1. Automated checks: Wait for CI/CD checks to pass
2. Maintainer review: A maintainer will review your changes
3. Feedback: Address any requested changes
4. Approval: Once approved, your PR will be merged

​

Responding to feedback

• Be open to suggestions and constructive criticism
• Make requested changes promptly
• Ask questions if feedback is unclear
• Keep discussions professional and respectful

​

Testing

​

Manual testing

​

Test coverage areas

• VPN connection (start/stop)
• System proxy configuration
• DNS resolver configuration
• HTTP proxy server
• SOCKS5 connection
• Settings persistence
• UI responsiveness
• Error handling
• Log output

​

Community guidelines

​

Be respectful

• Treat everyone with respect and kindness
• Welcome newcomers and help them get started
• Assume good intentions
• Keep discussions professional

​

Be collaborative

• Share knowledge and help others
• Provide constructive feedback
• Acknowledge contributions
• Work together towards common goals

​

Be patient

• Maintainers review contributions in their free time
• Not all features will be accepted
• Be understanding of different perspectives
• Take time to explain your reasoning

​

Getting help

1. Check existing issues: Someone may have already asked
2. Read the documentation: Most questions are answered in docs
3. Ask in discussions: Open a GitHub discussion
4. Be specific: Provide context and details

​

Recognition

• In the project README
• In release notes
• Through GitHub’s contributor graph
• With our sincere gratitude!