You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-5
Original file line number
Diff line number
Diff line change
@@ -101,9 +101,24 @@ You can contribute by forking and submitting a pull request (PR).
101
101
Some conditions for a PR to be accepted:
102
102
103
103
1) Text displayed in the application shall be internationalized.
104
-
- To do that use `NSLocalizedString`. Search on the code to see examples of usage.
105
-
- Add the localized string in all the lproj files in the same position. Use ChatGPT or DeepL to translate them to other languages.
104
+
- To do that use [NSLocalizedString](https://developer.apple.com/documentation/foundation/nslocalizedstring). Search on the code to see examples of usage.
105
+
- Add the keys of the localized string to all the `lproj` files. Keep this files organized in the same way (~ same line).
106
+
- Use [ChatGPT](https://chat.openai.com) or [DeepL](https://www.deepl.com/translator) to translate them to other languages. For example, for ChatGPT you can use a prompt similar to:
107
+
```
108
+
You are a language translator that is in the process of translating an mobile application for getting GPX traces in an iOS device.
109
+
110
+
Please provide the translation to the following languages:
111
+
German (de), Spanish (es), Chinese Simplified (zh-Hans), Ukranian (uk), Finnish (fi-FI), Russian (ru),French (fr), Dutch (nl), Portuguese Brazil (pt-BR), Italian (it)
112
+
113
+
of the following strings:
114
+
115
+
"TEXT_KEY" = "This is the text";
116
+
"TEXT_KEY" = "This is the text";
117
+
```
118
+
119
+
106
120
2) You need to install [swiftlint](https://github.com/realm/SwiftLint) and ensure you're not introducing additional lint warnings.
121
+
107
122
3) You need to document the classes and methods that you create explaining what do they do from a blackbox perspective. We use [jazzy](https://github.com/realm/jazzy) for the documentation. To install jazzy run:
108
123
```shell
109
124
gem install jazzy
@@ -115,10 +130,10 @@ Some conditions for a PR to be accepted:
115
130
**Note that it will generate the documents in the `../gh-pages/docs`.**
116
131
117
132
**PR License**
118
-
Please note that though the source code is licensed under GPL 3.0 by submitting a pull request you are also providing me (Juan M. Merlos) the rights to distribute those changes also on the binary app published on the App Store (which is released under Apple's Standard License Agreement)
133
+
Note that though the source code is licensed under GPL 3.0 by submitting a pull request you are also providing me (Juan M. Merlos) the rights to distribute those changes on the binary app published on the App Store (which is released under Apple's Standard License Agreement)
119
134
120
-
## License
121
-
Open GPX Tracker app for iOS. Copyright (C) 2014 Juan M. Merlos (@merlos) & Contributors
135
+
## GPL License
136
+
Open GPX Tracker app for iOS. Copyright (C) 2014-2023 Juan M. Merlos (@merlos) & Contributors
122
137
123
138
This program is free software: you can redistribute it and/or modify
124
139
it under the terms of the **GNU General Public License** as published by
0 commit comments