From d7d6afc2effafc5759b91e1454e648c128ebd46f Mon Sep 17 00:00:00 2001 From: Christian Paul Date: Sun, 8 Apr 2018 22:45:27 -0700 Subject: [PATCH] README and CONTRIBUTING capitalization and typo (#565) * Capitalize product names Java and GitHub * Fix capitalization and typo in the Feature list --- CONTRIBUTING.md | 8 ++++---- README.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43ce91384..99aa1290b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,19 @@ # Contributing ## Getting Started -1. Fork the repository on the Github page by clicking the Fork button. This makes a fork of the project under your Github account. +1. Fork the repository on the GitHub page by clicking the Fork button. This makes a fork of the project under your GitHub account. 2. Clone your fork to your machine. ```git clone https://github.com//Tusky``` 3. Create a new branch named after your change. ```git checkout -b your-change-name``` (```checkout``` switches to a branch, ```-b``` specifies that the branch is a new one) ## Making Changes ### Text -All english text that will be visible to users should be put in ```app/src/main/res/values/strings.xml```. Any text that is missing in a translation will fall back to the version in this file. Be aware that anything added to this file will need to be translated, so be very concise with wording and try to add as few things as possible. Look for existing strings to use first. If there is untranslatable text that you don't want to keep as a string constant in a java class, you can use the string resource file ```app/src/main/res/values/donottranslate.xml```. +All English text that will be visible to users should be put in ```app/src/main/res/values/strings.xml```. Any text that is missing in a translation will fall back to the version in this file. Be aware that anything added to this file will need to be translated, so be very concise with wording and try to add as few things as possible. Look for existing strings to use first. If there is untranslatable text that you don't want to keep as a string constant in a Java class, you can use the string resource file ```app/src/main/res/values/donottranslate.xml```. ### Translation Each translation has a single file that contains all of the text. A given locale's file can be found at ```app/src/main/res/values-[_]/strings.xml```. So, it could be ```values-en_US``` or ```values-es_ES```, for example. Specifically, they're the [two-letter ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) and the optional [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), which is used for a dialect of that particular country. -If you're starting a translation that doesn't already exist, you can just copy the english ```strings.xml``` to a new ```values``` directory and replace the english text inside each of the `````` `````` pairs. +If you're starting a translation that doesn't already exist, you can just copy the English ```strings.xml``` to a new ```values``` directory and replace the English text inside each of the `````` `````` pairs. Strings follow XML rules, which means that apostrophes and quotation marks have to be "escaped" with a backslash like: ```shouldn\'t``` and ```\"formidable\"```. Also, formatting is ignored when shown in the application, so things like new lines have to be explicitly expressed with codes like ```\n``` for a new line. See also: [String Resources](https://developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling). @@ -45,7 +45,7 @@ git rebase origin/master ``` It may refuse to start the rebase if there's changes that haven't been committed, so make sure you've added and committed everything. If there were changes on master to any of the parts of files you worked on, a conflict will arise when you rebase. [Resolving a merge conflict](https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line) is a good guide to help with this. After committing the resolution, you can run ```git rebase --continue``` to finish the rebase. If you want to cancel, like if you make some mistake in resolving the conflict, you can always do ```git rebase --abort```. -2. Push your local branch to your fork on Github by running ```git push origin your-change-name```. +2. Push your local branch to your fork on GitHub by running ```git push origin your-change-name```. 3. Then, go to the original project page and make a pull request. Select your fork/branch and use ```master``` as the base branch. 4. Wait for feedback on your pull request and be ready to make some changes diff --git a/README.md b/README.md index 6f7a27890..2bdc70e54 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,10 @@ Tusky is a beautiful Android client for [Mastodon](https://github.com/tootsuite/ - Material Design - Most Mastodon APIs implemented -- Muti-Account support +- Multi-Account support - Dark and Light theme with the possibility to auto-switch based on the time of day - Drafts - compose toots and save them for later -- completely Open-source - no non-free dependencies like Google services +- Completely open-source - no non-free dependencies like Google services ### Support