diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2b827acf..3bbc7439 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,62 +1,89 @@ -# How to submit Issue/Feature Request to *FastHub* +# Contributing to FastHub -- Make sure the included template is filled ( using FastHub will fill them up automatically ). -- If you planning to report multiple FRs/Issues that falls under the same feature __PLEASE REPORT THEM IN ONE TICKET__. -- Make sure you are always on latest (FastHub/About & Click on version name). -- Make sure the issue doesn't exists, lets keep things clean & tidy here :). +**Updated: 19 Jan 2018** +## Table of contents -# How to contribute & build *FastHub* +1. [Submitting Issues](#submitting-issues) +1. [How to contribute. Importing and assembling](#how-to-contribute-importing-and-assembling) + 1. [Custom keys *(optional)*](#custom-keys-optional) + 1. [Before importing into Android Studio](#before-importing-into-android-studio) + 1. [Before import](#before-importation) + 1. [Importing Android Studio project](#importing-android-studio-project) + 1. [Submitting Pull Request](#submitting-pull-request) +1. [Working with translations](#working-with-translations) +1. [Translations Contributors](#translations-contributors) -If you have a question in mind, feel free to come our public [Slack](http://rebrand.ly/fasthub) channel. +## Submitting Issues -### Optional +- Let's keep everything clean and tidy here :) + - Make sure that similar Issues are not exist. Reopen an Issue if exists but closed. + - If things you want to submit are related to each other, submit them in one Issue. +- None of the forked Repositories' Issues will be accepted! + - Forks are developed separately from the origin Repository. +- Make sure you are running latest version (to check it out withing the FastHub head to About and tap on the section with application's version). +- Make sure the included template is filled in (submitting an Issue within FastHub will do it automatically). -- Please update debug_gradle.properties file and change below if you like to use your own keys otherwise keep them as they're debug keys: - - github_client_id= your github clientId - - github_secret= your github secret - - redirect_url= (redirect_url must match the url defined in `AndroidManifest` under `LoginView`) +## How to contribute. Importing and assembling -### Before you import the project to Android Studio: +If you have any questions, feel free to join our public [Slack](http://rebrand.ly/fasthub) channel. -- Make sure you have Android Studio 3.0 C4 & above. -- Import Android Studio Settings (to ensure same code formatting) from this link [Click here](https://raw.githubusercontent.com/k0shk0sh/FastHub/master/fasthub_as_settings.jar) -- Install Lombok Plugin from Android Studio Plugins & enable Annotations Processors from (Android Studio Preference). +### Custom keys *(optional)* -### After above steps: +- Please update `debug_gradle.properties` file if you want to use your own keys: + - `github_client_id=` -- your GitHub clientId; + - `github_secret=` -- your GitHub secret; + - `redirect_url=` -- the url defined in `AndroidManifest` under `LoginView`. -- Fork the project. -- Clone it to your desktop. -- Open the project from Android Studio. -- Let it build & Start coding. +### Before importation -### Submitting PR +- Make sure you are running *Android Studio 3.0 C4* or above; +- Import *Android Studio Settings* (to follow project's code style) from [this file](https://raw.githubusercontent.com/k0shk0sh/FastHub/master/fasthub_as_settings.jar); +- Install *Lombok Plugin* from Android Studio Plugins and enable Annotations Processors in Android Studio Preferences. -> Please make sure your commit messages are meaningful. - -- Create new Branch with the feature or fix you made. -- Submit your PR with an explanation of what you did & why (~~if applicable~~). +### Importing Android Studio project + +- Fork the Repository. +- Clone it to your workstation. +- Open the project in Android Studio. +- Compile the project for the first time. Then you can start coding. + +### Submitting Pull Request + +> Please use meaningful commit messages. + +- Create a new Branch with the changes you made. +- Submit your Pull Request with an explanation of what have you done and why. > I really appreciate your efforts on contributing to this project. -# Contribute Translations +## Working with translations -1. First fork the repository by clicking **Fork** button. -1. Clone your own forked repository to your computer. -1. Create and switch branch by typing `git checkout -b ` where `` is the language you want to translate to. -1. Create a folder named `values-`, where `` is your 2 letter code for your language. For example `values-es` for Spanish, `values-fr` for French. -1. Copy `values/strings.xml` to inside `values-??` folder with `cp values/strings.xml values-??/`. -1. Open `values-??/strings.xml` on your editor of choice. -1. Translate and keep in mind those important points. - 1. Obey XML format. So, `ONLY TRANSLATE HERE`. - 1. Don't translate Git terms. Such as *pull request, push, commit, branch*... - 1. There are special characters and variables. Such as `\n` for newline, `\t` for tab. Keep them in the same position in your sentences. Do not delete them! - 1. Don't translate lines that contain `translatable="false"` statement. - 1. Don't add extra spaces or periods anywhere. Don't delete current ones. Keep them as is. -1. Once finished the translations, add files to the git index with `git add values-??/strings.xml` and commit it with `git commit -m 'Language: Strings translated'`. -1. Then push your local changes to your forked repository branch by typing `git push origin `. -1. Finally, create a pull request from your branch to our *master* with **Pull Request** button. +1. Firstly, you have to fork the repository by clicking the **Fork** button. +1. Clone your own forked repository to your workstation. +1. Create and switch Branch by typing `git checkout -b ` where `` is the name of the Branch you want to work with. We recommend you to name it into the language you want to translate in. +1. Create a new directory named like `values-`, where `` is a 2 letter ISO code of the language. For example `values-es` for Spanish, `values-fr` for French. +1. Copy `values/strings.xml` into the directory you have created (`values-??`). +1. Open `values-??/strings.xml` in your editor of choice. +1. Translate and keep in mind these important things. + 1. Obey the XML format. So, `ONLY TRANSLATE HERE`. + 1. Don't translate lines which contain `translatable="false"`. + 1. Don't translate Git and GitHub terms, such as *Pull Request*, *Push*, *Commit*, *Branch*, etc. + 1. There are some escape sequences used in translations (e.g. `\n` as a line feed (new line), `\t` as a tabulator. Don't delete them! + *For the full list you can see this [Wiki article](https://en.wikipedia.org/wiki/Control_character#In_ASCII).* + 1. There are some characters which **must be escaped** in translations. -# Translators + | `"` | `"` | + |-----|----------| + | `'` | `'` | + | `&` | `&` | + | `>` | `>` | + | `<` | `<` | + 1. Don't add extra spaces or periods. Don't delete existent ones. +1. Once you finished translating, add new files to the Git index using `git add values-??/strings.xml` command and commit the changes using `git commit -m ''`, where `` is a short description of changes you made. +1. Push your local changes into your forked repository by typing `git push origin `. +1. Finally, create a Pull Request from your Branch to our main Branch *development*. -- **English**: Default +## Translations Contributors + +- *See [README.md](https://github.com/k0shk0sh/FastHub#language-contributors)* diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 15ff17a8..6bb31a1c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -13,7 +13,7 @@ - Make sure the issue doesn't exists, lets keep things clean & tidy here :). --> -**FastHub Version:** <> +**FastHub Version:** **Android Version:** **Device Information:** - MANUFACTURER: