mirror of
https://github.com/pawelorzech/Swoosh.git
synced 2026-03-31 20:15:41 +00:00
74f42fd2f1
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
42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
# Contributing to Swoosh
|
|
|
|
Thanks for your interest in contributing! Here's how you can help.
|
|
|
|
## Getting started
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/Swoosh.git`
|
|
3. Create a feature branch: `git checkout -b feature/your-feature`
|
|
4. Make your changes
|
|
5. Run the tests: `./gradlew test`
|
|
6. Commit and push to your fork
|
|
7. 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](https://github.com/pawelorzech/Swoosh/issues) with:
|
|
|
|
- Steps to reproduce
|
|
- Expected vs actual behavior
|
|
- Android version and device info
|
|
|
|
## Feature requests
|
|
|
|
Open an [issue](https://github.com/pawelorzech/Swoosh/issues) 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](LICENSE).
|