mirror/UrlChecker
0
0
Fork 0
mirror of https://github.com/TrianguloY/UrlChecker.git synced 2024-09-19 20:02:16 +02:00
Code

Update CONTRIBUTING.md (#65)

Browse Source 
* Update CONTRIBUTING.md

(first step) added primary help for translators

* Update README.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

- added link to https://countrycode.org/ for country prefixes
- added the possibility to offer a translation via an issue (checked the requested title)

Co-authored-by: TrianguloY <correo--correo@hotmail.com>
This commit is contained in:
Ilithy 2022-08-23 15:25:36 +02:00 committed by GitHub
parent b3f2191222
commit fc52cc0244
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -1,7 +1,25 @@
I don't have a coding style, but try to keep it similar to existing code, with just a couple notes:
### For coder/developer:
We don't have a coding style, but try to keep it similar to existing code, with just a couple notes:
- Please write comments. No need to write full paragraphs for each line, but at least a minor comment for functions or non-obvious blocks of code really help.
- Try to make meaningful commits, when possible. On a PR I'll probably check everything together, but later it's nicer to have a detailed git log. For example: don't create a unique commit with everything, but also avoid very small ones. Usually a commit for each functionality/fix/improvement is enough.
- Try to make meaningful commits, when possible. On a PR we'll probably check everything together, but later it's nicer to have a detailed git log. For example: don't create a unique commit with everything, but also avoid very small ones. Usually a commit for each functionality/fix/improvement is enough.
You can check existing code to see examples, but be aware that some are not perfect. In doubt, just ask.
### For translator:
You are free to propose one or more translations, or to update any existing one. Be sure of your work before providing it to the developers, who cannot verify it. There are two independent things to translate:
- **App strings**: the [`strings.xml`](./app/src/main/res/values/strings.xml) file
- Translate all texts between the `<string>` and `</string>` tags.
- Remember to insert a backslash `\` before any apostrophe `'`, or enclose all text in quotes `"`
- Place the translated file in the corresponding `./app/src/main/res-{locale}/values/` folder
- **Store strings**: the [`title.txt`](./app/src/main/play/listings/en-US/title.txt) [`short-description.txt`](./app/src/main/play/listings/en-US/short-description.txt) and/or [`full-description.txt`](./app/src/main/play/listings/en-US/full-description.txt) files
- Place the translated files in the corresponding `./app/src/main/play/listings/{locale}/` folder
Note: if you are unsure the locale prefix of a specific language you can find it [here](https://countrycode.org/).
Optionally you can also send the files by email to [TrianguloY](https://github.com/TrianguloY) or by opening an [issue](https://github.com/TrianguloY/UrlChecker/issues/new) titled `{locale} Translation proposal`.

2
README.md
View File

@ -77,7 +77,7 @@ facilitating link sharing, protecting against certain phishing techniques and ma
Feel free to **suggest changes**, create [**issues**](https://github.com/TrianguloY/UrlChecker/issues/new) or even [**pull request**](https://help.github.com/articles/about-pull-requests/). _(from a simple typo fix to a full new module or even more!)_
Translations are also greatly appreciated.
See [CONTRIBUTING.md](CONTRIBUTING.md) for code details and tips.
See [CONTRIBUTING.md](CONTRIBUTING.md) for code or translation details and tips.
<!-- ---------- License ---------- -->