From 8f7296ddc2275471d4190df1dd55dee4025a5114 Mon Sep 17 00:00:00 2001 From: Distopico Date: Thu, 8 Nov 2018 19:19:51 -0500 Subject: [PATCH] add contributing file and move some files to docs --- CONTRIBUTING.md | 29 ++++++++++++++++++++++++ README.md | 47 +++++++-------------------------------- FAQ.md => docs/FAQ.md | 0 SETUP.md => docs/SETUP.md | 0 4 files changed, 37 insertions(+), 39 deletions(-) create mode 100644 CONTRIBUTING.md rename FAQ.md => docs/FAQ.md (100%) rename SETUP.md => docs/SETUP.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..cac2612d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contribution guide + +We're thrilled you're interested in contributing to SimpleEmail! There are lots of ways to get involved - see below for details. + +## Documentation + +Contributions to this document and the frequently asked questions +are preferred in the form of [pull requests][pull-requests]). + +## Translations + +* You can translate the in-app texts of SimpleEmail please open a [pull requests][pull-requests] (looking for a web service). +* If your language is not listed, please open a [issue][] or send a message through [email](distopico@riseup.net) + +## Source code + +Source code contributions are welcome, there's always work to be done on the SimpleEmail codebase, building from source code is +straightforward with [Android Studio](http://developer.android.com/sdk/). Here are the general rules: + +* Write good commit messages, we follow the [conventional commits][commits] +* Make sure the linter (`./gradlew lint`) passes (in progress) +* Stick to [F-Droid contribution guidelines](https://f-droid.org/wiki/page/Inclusion_Policy) +* Make changes on a separate branch, not on the master branch. This is commonly known as *feature branch workflow* +* Send patches via [Pull Requests][pull-requests], you branch should follow this convention: `[type]-[description]` example `feat-improve-performance` +* When submitting changes, you confirm that your code is licensed under the terms of the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html). +* Please test (compile and run) your code before you submit changes + + [commits]: https://www.conventionalcommits.org/en/v1.0.0-beta.2/ + [pull-requests]: https://framagit.org/dystopia-project/simple-email/merge_requests diff --git a/README.md b/README.md index e78637d3..9e299592 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ SimpleEmail is [Free Software][free-software], minimalistic and privacy friendly email app for Android. +* Easy navigation +* No unnecessary settings +* No bells and whistles +* Simple design + *This project has been forked from [FairEmail](https://github.com/M66B/open-source-email).* This email app might be for you if your current email app: @@ -14,10 +19,10 @@ This email app might be for you if your current email app: * is not maintained * stores your email on their servers * is closed source, potentially violating your privacy +* has "pro" features for basic things and hasn't transparent way to purchase that features -This app is minimalistic by design, so you can concentrate on reading and writing messages. - -This app starts a foreground service with a low priority status bar notification to make sure you'll never miss new email. +SimpleEmail is minimalistic by design, so you can concentrate on reading and writing messages, it starts a foreground +service with a low priority status bar notification to make sure you'll never miss new email. ## Features @@ -31,27 +36,12 @@ This app starts a foreground service with a low priority status bar notification * Battery friendly * Low data usage * Folder management -* Material design - -## Other features - * Signatures * Dark theme * Account colors -* Multiple select -* Standard replies -* Sort on time, unread or starred -* Search on server -* Preview sender/subject in new messages status bar notification * Encryption/decryption * Export settings -## Simple - -* Easy navigation -* No unnecessary settings -* No bells and whistles - ## Secure * Allow encrypted connections only @@ -93,29 +83,8 @@ See [here](https://framagit.org/dystopia-project/simple-email/blob/master/FAQ.md ## Support * For support on SimpleEmail, please open a [issue][] - * For support on authorizing accounts you should contact your provider. -## Contributing - -*Documentation* - -Contributions to this document and the frequently asked questions -are preferred in the form of [pull requests][pull-requests]). - -*Translations* - -* You can translate the in-app texts of SimpleEmail please open a [pull requests][pull-requests] (looking for a web service). -* If your language is not listed, please open a [issue][] or send a message through [email](distopico@riseup.net) - -*Source code* - -Building SimpleEmail from source code is straightforward with [Android Studio](http://developer.android.com/sdk/). - -Source code contributions are welcome, please open a [pull requests][pull-requests]. - -Please note that you agree to the license below by contributing. - ## Attribution SimpleEmail uses: diff --git a/FAQ.md b/docs/FAQ.md similarity index 100% rename from FAQ.md rename to docs/FAQ.md diff --git a/SETUP.md b/docs/SETUP.md similarity index 100% rename from SETUP.md rename to docs/SETUP.md