🤝 Contributing to ApWifi

April 1, 2026 · View on GitHub

🤝 Contributing to ApWifi

Help us make WiFi configuration on Raspberry Pi even better!

We love your input! We want to make contributing to ApWifi as easy and transparent as possible, whether it's:

🐛 Reporting bugs
🚀 Proposing new features
💡 Discussing the current state of the code
🔧 Submitting fixes or improvements
🌍 Adding translations
📖 Improving documentation

🎯 Ways to Contribute

🐛 Bug Reports

Found a bug? Please help us fix it!

Before reporting:

Check if the issue already exists in Issues
Test on the latest version
Gather relevant information (OS, .NET version, hardware)

Report template:

**Environment:**
- Raspberry Pi Model: 
- OS Version: 
- .NET Version: 
- ApWifi Version: 

**Bug Description:**
A clear description of what the bug is.

**Steps to Reproduce:**
1. Go to '...'
2. Click on '....'
3. See error

**Expected Behavior:**
What you expected to happen.

**Screenshots:**
If applicable, add screenshots.

🚀 Feature Requests

Have an idea for improvement?

Consider:

Is this feature useful for most users?
Does it align with the project goals?
Can it be implemented without breaking existing functionality?

🌍 Translations

Help make ApWifi accessible worldwide!

Currently supported languages:

🇺🇸 English (en-US)
🇨🇳 Chinese (zh-CN)
🇩🇪 German (de-DE)
🇫🇷 French (fr-FR)
🇯🇵 Japanese (ja-JP)

To add a new language:

Create Strings.[locale].json in ApWifi.App/Resources/
Translate all strings from Strings.en-US.json
Test the interface with your translation
Submit a pull request

📖 Documentation

Help others use and contribute to ApWifi!

Areas that need help:

API documentation
Tutorial improvements
Code examples
Troubleshooting guides

🔧 Development Setup

Prerequisites

.NET 10 SDK
Git
(Optional) Raspberry Pi 5 for hardware testing

Setup Steps

Fork the repository

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

Create a feature branch

git checkout -b feature/your-feature-name

Install dependencies
```
dotnet restore
```
Build the project
```
dotnet build
```
Run tests
```
dotnet test
```
Start development
```
dotnet run --project ApWifi.App
```

📝 Pull Request Process

Before Submitting

✅ Code builds without warnings
✅ All tests pass
✅ Code follows project style
✅ Documentation updated if needed
✅ Screenshots added for UI changes

PR Template

## Description
Brief description of changes.

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Testing
- [ ] Tested on development environment
- [ ] Tested on Raspberry Pi hardware
- [ ] All existing tests pass
- [ ] New tests added if applicable

## Screenshots
Include screenshots for UI changes.

## Checklist
- [ ] Code follows project style guidelines
- [ ] Self-review completed
- [ ] Documentation updated
- [ ] No new warnings introduced

🎨 Code Style Guidelines

C# Conventions

Use PascalCase for public members
Use camelCase for private fields
Use meaningful variable names
Add XML documentation for public APIs
Follow async/await best practices

Example:

/// <summary>
/// Configures WiFi settings on the system
/// </summary>
/// <param name="ssid">Network SSID</param>
/// <param name="password">Network password</param>
/// <returns>True if configuration was successful</returns>
public async Task<bool> ConfigureWiFiAsync(string ssid, string password)
{
    // Implementation
}