mirror of https://github.com/pawelorzech/Swoosh.git synced 2026-03-31 11:55:47 +00:00

docs: add open-source project files (README, license, contributing)

Add professional open-source scaffolding:
- README.md with badges, features, architecture, and setup guide
- LICENSE (PolyForm Noncommercial 1.0.0)
- CONTRIBUTING.md with guidelines
- CHANGELOG.md for v1.0.0
- GitHub issue and PR templates
- Updated .gitignore

2026-03-19 10:17:46 +01:00

1.1 KiB

Raw Blame History

Contributing to Swoosh

Thanks for your interest in contributing! Here's how you can help.

Getting started

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/Swoosh.git
Create a feature branch: git checkout -b feature/your-feature
Make your changes
Run the tests: ./gradlew test
Commit and push to your fork
Open a Pull Request

Development setup

Android Studio Hedgehog (2023.1.1) or later
JDK 17
Android SDK 34

Guidelines

Follow existing code style and patterns (MVVM, Repository, Compose)
Write tests for new functionality
Keep commits focused — one logical change per commit
Use descriptive commit messages

Reporting bugs

Open an issue with:

Steps to reproduce
Expected vs actual behavior
Android version and device info

Feature requests

Open an issue with a description of the feature and why it would be useful.

License

By contributing, you agree that your contributions will be licensed under the PolyForm Noncommercial License 1.0.0.

1.1 KiB Raw Blame History