Skip to content

Commit b2da894

Browse files
committed
Readme: update contribute section
1 parent b03785c commit b2da894

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

Diff for: README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,24 @@ The application is being documented using [jazzy](https://github.com/realm/jazzy
9191
[Read Source code documentation](https://www.merlos.org/iOS-Open-GPX-Tracker/docs/index.html)
9292

9393
## Contribute
94-
You can contribute by forking and submitting a pull request.
94+
95+
You can contribute by forking and submitting a pull request (PR).
96+
97+
Some conditions for a PR to be accepted:
98+
99+
1) Text displayed in the application shall be internationalized.
100+
- To do that use `NSLocalizedString`. Search on the code to see examples of usage.
101+
- Add the localized string in all the lproj files in the same position. Use ChatGPT or DeepL to translate them to other languages.
102+
2) You need to install [swiftlint](https://github.com/realm/SwiftLint) and ensure you're not introducing additional lint warnings.
103+
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:
104+
```shell
105+
gem install jazzy
106+
```
107+
Then, to view the documentation run
108+
```shell
109+
jazzy
110+
```
111+
**Note that it will generate the documents in the `../gh-pages/docs`.**
95112

96113
Please note that by submitting any pull request you are providing me (Juan M. Merlos) the rights to include and distribute those changes also on the binary app published on the App Store (which is released under Apple's Standard License Agreement)
97114

0 commit comments

Comments
 (0)