From aa31f92a6541953e3ca5358c7a210254224d9098 Mon Sep 17 00:00:00 2001 From: Christophe Henry Date: Thu, 21 Mar 2019 14:27:36 +0100 Subject: [PATCH] Add contributing and changelog --- CHANGELOG.md | 48 +++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +-- 3 files changed, 119 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a64b4ac --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,48 @@ +# Development + +## Features + +* Swipe gesture to navigate between subscription sections ([a0a0b690](https://git.feneas.org/christophehenry/freshrss-android/commit/a0a0b690dc2e720e195449ea2865ff2ca2d11b41)) +* Sort subscriptions alphabetically in *all* section and by newest item crawl date in *unread* section ([a0a0b690](https://git.feneas.org/christophehenry/freshrss-android/commit/a0a0b690dc2e720e195449ea2865ff2ca2d11b41)) +* Implement [#9](https://git.feneas.org/christophehenry/freshrss-android/issues/9): pull-to-refresh pattern to sync with server ([65f48ded](https://git.feneas.org/christophehenry/freshrss-android/commit/65f48ded3bfb8b1cb2aa50578c5078f25c75a57a)) +* Add animation in views's transtions ([4f84e6b5](https://git.feneas.org/christophehenry/freshrss-android/commit/4f84e6b5f6de7d42a24d541e099a402d034792da)) +* Implement [#10](https://git.feneas.org/christophehenry/freshrss-android/issues/10) : fetch subscription's icons and display them ([!4](https://git.feneas.org/christophehenry/freshrss-android/merge_requests/4)) +* Add sections and section headers to subscriptions ([!10](https://git.feneas.org/christophehenry/freshrss-android/merge_requests/5)) + +## Bug fixes + +* Fix service lately binded to application causing stacktrace ([a58c00dd](https://git.feneas.org/christophehenry/freshrss-android/commit/a58c00dd8c8c6e292a0210a64a38238b253978a4)) +* Fix loader displaying infinitely when a subscription section stays empty after refresh by displaying a hint text stating section is empty ([13b7c02c](https://git.feneas.org/christophehenry/freshrss-android/commit/13b7c02c28bfdfd543de668006dff161330e3b75)) +* Fix [#38](https://git.feneas.org/christophehenry/freshrss-android/issues/38]: empty screen when going back from the initial screen ([4f84e6b5](https://git.feneas.org/christophehenry/freshrss-android/commit/4f84e6b5f6de7d42a24d541e099a402d034792da)) +* Fix [#13](https://git.feneas.org/christophehenry/freshrss-android/issues/13) and [#14](https://git.feneas.org/christophehenry/freshrss-android/issues/14): erratic notification behavior ([0c1b5e76](https://git.feneas.org/christophehenry/freshrss-android/commit/0c1b5e7600888d905f67dc28b0389229b52b67f7)) +* Fix crash hapening when object is returned from `unread-counts` endpoint without `newestItemTimestampUsec` property ([8cfcd932](https://git.feneas.org/christophehenry/freshrss-android/commit/8cfcd932619b601371b6f0d0a4bcb7d4b92ce3dd)) +* Fix spinner infinitely loading when comming back from a feed with a single unread article ([3088922f](https://git.feneas.org/christophehenry/freshrss-android/commit/3088922f9405ee173d6a6cb81b8868a35759aedd)) +* Fix articles in subscriptions not being sorted by publication date ([3088922f](https://git.feneas.org/christophehenry/freshrss-android/commit/3088922f9405ee173d6a6cb81b8868a35759aedd)) + +## Refactoring + +* Feed subscriptions uses a local DB ([edfd4fc5](https://git.feneas.org/christophehenry/freshrss-android/commit/edfd4fc5cde846ca6040c55b31179e107b654ddf)) +* Cleanup in DataBing classes ([353f37d1](https://git.feneas.org/christophehenry/freshrss-android/commit/353f37d15c12cad108610ec3061d7f09503b290b)) + +# 1.0.1 + +## Bug fixes + +* Fix Jackson crash when runing on an API level < 24 ([90c65dc7](https://git.feneas.org/christophehenry/freshrss-android/commit/90c65dc7387c94689e8bffd4f80168d29c909bae)) + +# 1.0.0 + +## Features + +Basic implementation using FreshRSS' GReader HTTP API implmentation. This lets you: + + * connect to one account + * browse all subscriptions + * browse subscriptions with unread articles + * see articles for a subscription + * see unread articles for a subscription + * read an article + * set an article as read/unread + * share an article to other android application + * open the original page of the article + * refresh your feed \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5e5fa0b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,70 @@ +# Foreword + +## Contributing is not only about throwing code + +Any project needs several different profiles. Contributing is not only about producing code. +A good project is a project that has a triving community producing improvement propositions, +graphic assets, communication, translations, etc. + +If you think you are not able to contribute because you cannot produce code: **DON'T**. Please... + +Developers are not all-knowing people. They need to colaborate with people having multiple talents. +Opening a ticket to raise a bug or ask for a feature is already a huge contribution. +Translating text, propose interface improvement or draw graphics also are. + +## If you don't know something, ask + +It's ok to not know how to develop an Android application or to use `git`. +Documentations are good assets if you know what you are searching for and +how to formulate the question, but sometimes, it's not enough. + +In such cases, it's really ok to ask. It's faster and easier and you can be guided. +Never hesitate to seek help among other contributor. Life is all about learning! + +# Technique + +Before you start developing, you should install [Android studio](https://developer.android.com/studio/install), +Android's, integrated development enrionment. + +Read the [contributing section of the README](https://git.feneas.org/christophehenry/freshrss-android#contributing). + +Pick [a ticket](https://git.feneas.org/christophehenry/freshrss-android/issues), +preferably, on that is marked for the next release and start working on it. + +Apart from application's features and development, this project is severely +lacking tests and a good CI pipeline. Feel free to set them up if you feel +you have the knowledge. + +# Contributors + +## The community and the users + +Thank you a lot for using this app, talking about it, loving it ❤️ + +## Translators + +There are no translators yet. The whole application is in English. +If you want to translate in your language feel free to do so. +Read [Android's documentation on translations](https://developer.android.com/studio/write/translations-editor). + +## UI Graphism + +There are no graphists yet. If you think you can improve the look of the application +please, submit propositions. We desperatly need you. + +## UX + +* Natouille + +## Ticket openers + +These section thanks the users opening ticket to raise bug or propose features + +* [GLLM](https://git.feneas.org/GLLM) + +And others: also thanks to you, anonymous ones that open only one and a fistful of tickets +on the project. You, too, matter and deserve a thank you. + +## Devs + +* [Christophe](https://git.feneas.org/christophehenry) \ No newline at end of file diff --git a/README.md b/README.md index 2ebe0d9..bab0f73 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,7 @@ It would be advised to read [Android's guid to app architecture](https://develop 5. You can debug your application using [Facebook's Stetho](http://facebook.github.io/stetho/). -6. Serialization and deserialization of HTTP request is handled by [Kotlinx serialization library](https://github.com/Kotlin/kotlinx.serialization/blob/master/README.md#kotlin-cross-platform--multi-format-reflectionless-serialization). -(Might be an idea to move to [`fuel-livedata`](https://fuel.gitbook.io/documentation/support/fuel-livedata) in the future. Requires digging.) +6. Serialization and deserialization of HTTP request is handled by [Jackson](https://github.com/FasterXML/jackson-core). ## License -- GitLab