Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 2.8 KB

How to contribute & build FastHub

If you have a question in mind, feel free to come our public Slack channel.

Optional

  • 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)

Before you import the project to Android Studio:

  • Make sure you have Android Studio 3.0 C4 & above.
  • Import Android Studio Settings (to ensure same code formatting) from this link Click here
  • Install Lombok Plugin from Android Studio Plugins & enable Annotations Processors from (Android Studio Preference).

After above steps:

  • Fork the project.
  • Clone it to your desktop.
  • Open the project from Android Studio.
  • Let it build & Start coding.

Submitting PR

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).

I really appreciate your efforts on contributing to this project.

Contribute Translations

  1. First fork the repository by clicking Fork button.
  2. Clone your own forked repository to your computer.
  3. Create and switch branch by typing git checkout -b <language> where <language> is the language you want to translate to.
  4. Create a folder named values-<language-code>, where <language-code> is your 2 letter code for your language. For example values-es for Spanish, values-fr for French.
  5. Copy values/strings.xml to inside values-?? folder with cp values/strings.xml values-??/.
  6. Open values-??/strings.xml on your editor of choice.
  7. Translate and keep in mind those important points.
    1. Obey XML format. So, <string name="do-not-change">ONLY TRANSLATE HERE</string>.
    2. Don't translate Git terms. Such as pull request, push, commit, branch...
    3. 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!
    4. Don't translate lines that contain translatable="false" statement.
    5. Don't add extra spaces or periods anywhere. Don't delete current ones. Keep them as is.
  8. 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'.
  9. Then push your local changes to your forked repository branch by typing git push origin <language>.
  10. Finally, create a pull request from your branch to our master with Pull Request button.

Translators

  • English: Default