diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..4bfcb471 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +Ultrasonic development is a community project, and contributions are welcomed. + +First, see if your issue haven’t been yet reported [here](https://github.com/ultrasonic/ultrasonic/issues), +then, please, first discuss the change you wish to make via [a new issue](https://github.com/ultrasonic/ultrasonic/issues/new). + +### Here are a few guidelines you should follow before submitting: +1. **License Acceptance:** All contributions must be licensed as [GNU GPLv3](LICENSE) to be accepted. +Use `git commit --signoff` to acknowledge this. +2. **App is migrating to [Kotlin](https://kotlinlang.org/) programming language:** new Pull Requests +should be written in this programming language. +3. **No Breakage:** New features or changes to existing ones must not degrade the user experience. +4. **Coding standards** best-practices should be followed, comment generously, and avoid "clever" algorithms. +Refactoring existing messes is great, but watch out for breakage. +5. **No large PR:*** Try to limit the scope of PR only to the related issue, so it will be easier to review +and test. + +## Pull Request Process + +1. Ensure all commits are signed-off. +2. Check tests for the new code are added. +3. Check code style is passing. +4. Check code static analysis is passing. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index ee94f0c3..59494c71 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1 +1,20 @@ -Please, take note that this project is STALLED. See README.md for more info. +## Problem description + +Describe your problem here. Describe what you want to happen, and what happens +if you try to do it. If you have a stack trace or any logs, please format them using +github triple backquote notation + +### Steps to reproduce + +Describe how somebody else could observe the same behavior you do. Don't share here any logins and +passwords! + +## System information + + * **Ultrasonic version**: *version of the app* + * **Android version**: *Version of Android OS on the device* + * **Device info**: *Device manufacturer, model* + +## Additional notes + +Include any extra notes here. Otherwise you may remove this section. diff --git a/README.md b/README.md index f1dd72c8..cc17e4ca 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,25 @@ []() [](https://ktlint.github.io/) -Subsonic Music Streamer Android client +Ultrasonic is free, open-source [Subsonic](http://www.subsonic.org/) [API](http://www.subsonic.org/pages/api.jsp) compatible music streaming Android client. -## About project status +## Download -WARNING: This project is **STALLED** +App is available to download at following stores: + - [Google play store](https://play.google.com/store/apps/details?id=org.moire.ultrasonic) + - [F-Droid](https://f-droid.org) - coming soon... + +## Bugs and issue -This means that I don't have time to fix bugs or add new features, but you can send me **Pull Requests** and I **promise** that I shall merge and upload to Play Store. +First, see if your issue haven’t been yet reported [here](https://github.com/ultrasonic/ultrasonic/issues), +otherwise open [a new issue](https://github.com/ultrasonic/ultrasonic/issues/new). -If you want contribute at project you can see the [issues](https://github.com/ogarcia/ultrasonic/issues) page and try to fix the discovered bugs or implement the enhancements that users report there. +## Contributing -If you want give more active development, please contact with me cause I can give you access to repository to do work faster. +See [CONTRIBUTING](CONTRIBUTING.md). + +## License + +This software is licensed under the terms of the GNU General Public License version 3 (GPLv3). + +Full text of the license is available in the [LICENSE](LICENSE) file and [online](https://opensource.org/licenses/gpl-3.0.html).