From 2f45a42829bb9bd43112adbe5c165e850a298fbc Mon Sep 17 00:00:00 2001 From: mhmdanas <6daf084a-8eaf-40fb-86c7-8500077c3b69@anonaddy.me> Date: Mon, 1 Feb 2021 10:17:22 +0300 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ README.md | 21 ++------------------- 2 files changed, 36 insertions(+), 19 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..70cf94cb4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +### Translation + +You can translate Tasks using [Weblate](https://hosted.weblate.org/projects/tasks/android). To get started, register a new account or login with your GitHub account if you have one. + +### Opening issues + +Before opening an issue, please make sure that your issue: +- is not a duplicate (i.e. it has not been reported before, closed or open) +- has not been fixed +- is in English (issues in a language other than English will be closed unless someone translates them) +- does not contain multiple feature requests/bug reports. Please open a separate issue for each one. + +### Code contribution + +#### To get started with development: +1. [Fork](https://help.github.com/articles/fork-a-repo/) and [clone](https://help.github.com/articles/cloning-a-repository/) the repository +2. Install and launch [Android Studio](https://developer.android.com/studio/index.html) +3. Select `File > Open`, select the Tasks directory, and accept prompts to install missing SDK components + +#### Set up Mapbox +1. Register at [mapbox.com](https://www.mapbox.com) +2. Add `tasks_mapbox_key_debug=""` to your [`gradle.properties`](https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties) file. You can create an access token or use your [default public token](https://docs.mapbox.com/help/glossary/access-token/#default-public-token) + +#### Set up Google Tasks and Google Drive +1. Register at [cloud.google.com](https://cloud.google.com) +2. Enable [Google Tasks API](https://console.cloud.google.com/apis/library/tasks.googleapis.com) and [Google Drive API](https://console.cloud.google.com/apis/library/drive.googleapis.com) +3. [Create android authorization credentials](https://developers.google.com/identity/protocols/OAuth2InstalledApp#creatingcred) + +#### Set up Google Maps and Google Places +1. Register at [cloud.google.com](https://cloud.google.com) +2. Enable [Google Maps SDK](https://console.cloud.google.com/apis/library/maps-android-backend.googleapis.com) and [Google Places API](https://console.cloud.google.com/apis/library/places-backend.googleapis.com) +3. [Set up an API key](https://cloud.google.com/video-intelligence/docs/common/auth#set_up_an_api_key) +4. Add `tasks_google_key_debug=""` to your [`gradle.properties`](https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties) file +5. Select `Build > Select Build Variant` and choose the `googleplay` variant diff --git a/README.md b/README.md index 18813e0ef..1a5bc5235 100644 --- a/README.md +++ b/README.md @@ -17,23 +17,6 @@ Please visit [tasks.org](https://tasks.org) for end user documentation and suppo ![tests](https://github.com/tasks/tasks/workflows/Run%20tests/badge.svg) [![weblate](https://hosted.weblate.org/widgets/tasks/-/android/svg-badge.svg)](https://hosted.weblate.org/engage/tasks/?utm_source=widget) [![codecov](https://codecov.io/gh/tasks/tasks/branch/main/graph/badge.svg)](https://codecov.io/gh/tasks/tasks) [![codebeat badge](https://codebeat.co/badges/07924fca-2f18-4eff-99a3-120ec5ac2d5f)](https://codebeat.co/projects/github-com-tasks-tasks-main) -#### To get started with development: -1. [Fork](https://help.github.com/articles/fork-a-repo/) and [clone](https://help.github.com/articles/cloning-a-repository/) the repository -2. Install and launch [Android Studio](https://developer.android.com/studio/index.html) -3. Select `File > Open`, select the Tasks directory, and accept prompts to install missing SDK components +### Contributing -#### Set up Mapbox -1. Register at [mapbox.com](https://www.mapbox.com) -2. Add `tasks_mapbox_key_debug=""` to your [`gradle.properties`](https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties) file. You can create an access token or use your [default public token](https://docs.mapbox.com/help/glossary/access-token/#default-public-token) - -#### Set up Google Tasks and Google Drive -1. Register at [cloud.google.com](https://cloud.google.com) -2. Enable [Google Tasks API](https://console.cloud.google.com/apis/library/tasks.googleapis.com) and [Google Drive API](https://console.cloud.google.com/apis/library/drive.googleapis.com) -3. [Create android authorization credentials](https://developers.google.com/identity/protocols/OAuth2InstalledApp#creatingcred) - -#### Set up Google Maps and Google Places -1. Register at [cloud.google.com](https://cloud.google.com) -2. Enable [Google Maps SDK](https://console.cloud.google.com/apis/library/maps-android-backend.googleapis.com) and [Google Places API](https://console.cloud.google.com/apis/library/places-backend.googleapis.com) -3. [Set up an API key](https://cloud.google.com/video-intelligence/docs/common/auth#set_up_an_api_key) -4. Add `tasks_google_key_debug=""` to your [`gradle.properties`](https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties) file -5. Select `Build > Select Build Variant` and choose the `googleplay` variant +Contributions are always welcome! Whether translations, code changes, bug reports, feature requests, or otherwise, your help is appreciated. To get started, take a look at [CONTRIBUTING.md](CONTRIBUTING.md).