mirror of
https://github.com/WSA-Installer/wsa-webdav.git
synced 2026-07-29 11:24:16 -07:00
78 lines
1.6 KiB
Markdown
78 lines
1.6 KiB
Markdown
# Contributing to WSA WebDev
|
|
|
|
Thank you for your interest in contributing to WSA WebDev!
|
|
|
|
## How to Contribute
|
|
|
|
### Reporting Bugs
|
|
|
|
1. Check [existing issues](https://github.com/WSA-Installer/wsa-webdav/issues) first
|
|
2. Open a new issue with:
|
|
- Clear title and description
|
|
- Steps to reproduce
|
|
- Expected vs actual behavior
|
|
- Device/environment details
|
|
|
|
### Suggesting Features
|
|
|
|
1. Open a [feature request](https://github.com/WSA-Installer/wsa-webdav/issues/new?template=feature_request.yml)
|
|
2. Describe the problem and proposed solution
|
|
|
|
### Pull Requests
|
|
|
|
1. Fork the repository
|
|
2. Create a feature branch
|
|
3. Make your changes
|
|
4. Test on WSA
|
|
5. Submit a Pull Request
|
|
|
|
## Development Setup
|
|
|
|
### Prerequisites
|
|
|
|
- JDK 17
|
|
- Python 3
|
|
- Android SDK (auto-installed by build script)
|
|
- WSA with ADB access
|
|
|
|
### Building
|
|
|
|
```bash
|
|
# Windows
|
|
build.bat
|
|
|
|
# Linux/Mac
|
|
./build.sh
|
|
```
|
|
|
|
The build script will:
|
|
1. Check Java installation
|
|
2. Download Android SDK if needed
|
|
3. Generate Kotlin source files
|
|
4. Build the APK
|
|
|
|
### Testing
|
|
|
|
1. Install the APK: `adb install output/app-release.apk`
|
|
2. Start the server: `adb shell am start -n com.wsa.webdav/.MainActivity`
|
|
3. Access the web file manager: `http://127.0.0.1:8088`
|
|
4. Test WebDAV: `curl -X PROPFIND http://127.0.0.1:8088/files/`
|
|
|
|
## Code Style
|
|
|
|
### Kotlin
|
|
|
|
- Follow Kotlin coding conventions
|
|
- Use meaningful variable names
|
|
- Add KDoc comments for public APIs
|
|
|
|
### Build Script
|
|
|
|
- Python 3 compatible
|
|
- No external dependencies (stdlib only)
|
|
- Use `write_bytes()` for file output
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the MIT License.
|