From 07ab11111a6f2046b80955bf0dbc445bad0e4d09 Mon Sep 17 00:00:00 2001 From: Sven Jacobs Date: Wed, 9 Nov 2022 09:04:07 +0100 Subject: [PATCH] doc: Update documentation (#129) * doc: Update CHANGELOG.md * doc: Update CONTRIBUTING.md --- CHANGELOG.md | 133 +----------------------------------------------- CONTRIBUTING.md | 16 ++++-- 2 files changed, 12 insertions(+), 137 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f33da2c6..c891d6b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,132 +1 @@ -## Version 18 - -_2022-11-06_ - -- Identical to previous version, just fixes a build issue on F-Droid - -## Version 17 ๐ŸŽƒ - -_2022-10-31_ - -- Happy Halloween! ๐ŸŽƒ -- Fix crash in license screen -- Changed versioning schema from semantic versioning to an incrementing number. - Semantic versioning makes sense for a library but not so much for an application like Lรฉon. - -## Version 1.2.0 - -_2022-10-01_ - -- Add eBay sanitizer - -## Version 1.1.0 - -_2022-09-18_ - -- Add sanitizer for YouTube redirection links -- Add sanitizer for Amazon non-product pages -- Add Youtu.be short URL sanitizer -- Add feature to register app as a browser - -## Version 1.0.1 - -_2022-08-05_ - -- Add missing `q` parameter to Google sanitizer -- Improve sharing -- Update Russian translations - -## Version 1.0.0 - -_2022-07-17_ - -- Add "import from clipboard" functionality -- Add "decode URL" & "extract only URL" functionality -- Add Google, Yahoo & AOL search result sanitizers -- Add Amazon Smile sanitizer / domain rewriter -- Add Russian translations (thanks @chel1k) - -## Version 0.10.0 - -_2022-07-15_ - -- Add Instagram sanitizer -- Add sanitizer for generic session IDs -- Add sanitizer for empty parameters - -## Version 0.9.0 - -_2022-06-05_ - -- Add "copy to clipboard" functionality -- Material You design - -## Version 0.8.0 - -_2022-05-29_ - -- Add sanitizer for Flipkart - -## Version 0.7.1 - -_2022-04-10_ - -- Fix: don't remove anchors from URLs ([#41](https://github.com/svenjacobs/leon/issues/41), thanks - @slootsky) - -## Version 0.7.0 - -_2021-10-29_ - -- Add `t` parameter to Twitter sanitizer. - -## Version 0.6.0 - -_2021-10-20_ - -- Fix display of title for large fonts (PR #30, thanks @yuhuitech) -- Add sanitizers for - - Twitter - - Spotify - - Netflix -- Minor UI improvements - -## Version 0.5.0 - -_2021-06-13_ - -- Add sanitizer for Amazon domains (#18) -- Add `fbclid` parameter to Facebook sanitizer (#20) -- Improve accessibility of app (#17) - -Thanks to @adeekshith and @jimcarst for their feedback! - -## Version 0.4.1 - -_2021-06-06_ - -- Fix back navigation icon not visible in preferences - -## Version 0.4.0 - -_2021-06-03_ - -- Add Facebook query parameters - -## Version 0.3.0 - -_2021-05-24_ - -- Change how version code is declared in build process - -## Version 0.2.0 - -_2021-05-23_ - -- Add regex based sanitizer - -## Version 0.1.0 - -_2021-05-22_ - -- First public beta release. +Please see [releases](https://github.com/svenjacobs/leon/releases) on GitHub for changes. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f54e84f..e2152e60 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,12 @@ -Contributions in terms of [bug reports](https://github.com/svenjacobs/leon/issues), feature -requests, [discussions](https://github.com/svenjacobs/leon/discussions) or pull requests are always -welcome. +All kinds of contributions are welcomed. For example -However before starting to write code, let's please discuss the change first. Please create an issue -or a discussion for your desired change. Thank you. +- implementing features or fixing bugs (see [issues](https://github.com/svenjacobs/leon/issues)) +- providing ideas and feedback +- testing +- translations +- designs and graphics + +[All contributors](https://allcontributors.org/) are recognized. + +Please use [issues](https://github.com/svenjacobs/leon/issues) and +[discussions](https://github.com/svenjacobs/leon/discussions) to get in touch with us.