From ded846904a7da211e2d8efb0361aff80fd96e876 Mon Sep 17 00:00:00 2001 From: Distopico Vegan Date: Sat, 8 Dec 2018 14:33:10 -0500 Subject: [PATCH] chore: update contributing --- CONTRIBUTING.md | 3 ++- README.md | 12 ++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c5bdf12..8086c251 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ are preferred in the form of [pull requests][pull-requests]). ## Source code -Source code contributions are welcome, there's always work to be done on the SimpleEmail codebase, building from source code is +Source code contributions are welcome, there's always work to be done on the SimpleEmail codebase, building from source code is straightforward with `./gradlew assembleDebug` Here are the general rules: * Write good commit messages, we follow the [conventional commits][commits] @@ -25,5 +25,6 @@ straightforward with `./gradlew assembleDebug` Here are the general rules: * 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 + [issue]: https://framagit.org/dystopia-project/simple-email/issues [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 e00dda84..b10af75b 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Alternatively, you can download directly from GitLab [Releases][gitlab-releases] The focus of SimpleEmail is be a privacy-friendly email app with a good UX/UI and with a community development model. -SimpleEmail is minimalistic by design, so you can concentrate on reading and writing messages, it starts a foreground +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 a new email. *This project has been forked from [FairEmail](https://framagit.org/dystopia-project/simple-email/blob/master/docs/FAQ.md#what-is-the-difference-between-simpleemail-and-fairemail).* @@ -94,7 +94,7 @@ See [here][faqs] for a list of often asked questions. ## Contributing Whether you have ideas, translations, features you think are missing, design or code changes, help is always welcome!. -You can submit [pull requests][pull-requests] to this repository, or submit translations using Weblate. +You can submit [pull requests][pull-requests] to this repository, or submit translations using [Weblate](https://hosted.weblate.org/projects/simple-email/). To get started, take a look at [CONTRIBUTING.md](https://framagit.org/dystopia-project/simple-email/blob/develop/CONTRIBUTING.md) @@ -117,21 +117,21 @@ SimpleEmail uses: Copyright 2018, Marcel Bokhorst (M66B) Copyright 2018, Distopico (dystopia project) and contributors - + This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + You should have received a copy of the GNU General Public License along with this program. If not, see . -* All assets and docs are under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/), +* All assets and docs are under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/), for the license of the image used in the [assets](/assets) please see the metadata under the SVG file. [free-software]: https://www.gnu.org/philosophy/free-sw.html