mirror of
https://codeberg.org/comaps/comaps
synced 2025-12-19 04:53:36 +00:00
[docs] Update docs about default git branch
Signed-off-by: jeanbaptisteC <jeanbaptistec@noreply.codeberg.org>
This commit is contained in:
Jean-Baptiste
@@ -50,4 +50,4 @@ In the past, once someone wanted to contribute they needed to go through the CLA
|
||||
|
||||
## Contributors
|
||||
|
||||
Please feel free to add your name to [CONTRIBUTORS](https://codeberg.org/comaps/comaps/blob/master/CONTRIBUTORS) in your first PR.
|
||||
Please feel free to add your name to [CONTRIBUTORS](https://codeberg.org/comaps/comaps/src/branch/main/CONTRIBUTORS) in your first PR.
|
||||
|
||||
@@ -40,7 +40,7 @@
|
||||
- Functions and methods should not be long. In most cases, it's good if the whole body of a function or method fits on the monitor. It's good to write a function or a method shorter than 60 lines
|
||||
- Source files should not be very long
|
||||
- If you are solving a big task it's worth splitting it into subtasks and develop one or several PRs for every subtask.
|
||||
- If it's necessary to make a big change list which should be merged to master at once, it's worth creating a branch and make PRs on it. Then to make PR with all commits of the branch to the master
|
||||
- If it's necessary to make a big change list which should be merged to main at once, it's worth creating a branch and make PRs on it. Then to make PR with all commits of the branch to the main
|
||||
- In most cases refactoring should be done in a separate PR
|
||||
- If you want to refactor a significant part of the code base, it's worth discussing it with all developers before starting work
|
||||
- It's worth using the 'Resolve' conversation button to minimize the list of comments in a PR
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
For the subway layer to be available in CoMaps, a `SUBWAY_URL`
|
||||
parameter ought to be provided to the
|
||||
[map generator](https://codeberg.org/comaps/comaps/tree/master/tools/python/maps_generator).
|
||||
[map generator](https://codeberg.org/comaps/comaps/src/branch/main/tools/python/maps_generator).
|
||||
Normally you can specify this link https://cdn.comaps.app/subway.json,
|
||||
which provides a regularly updated file.
|
||||
These instructions describe how to manually build a subway layer file.
|
||||
|
||||
@@ -64,7 +64,7 @@ Weblate maintains an internal copy of the Git repository. The repository URL can
|
||||
|
||||
Translations are extracted from the repository and stored in an internal database, which is used by the Weblate UI. Every 24 hours, this internal database is synchronized back to the internal repository. This process can also be triggered manually via _Manage → Repository Maintenance → Commit_.
|
||||
|
||||
After committing changes from the internal database to the internal repository, Weblate pushes all updates to the `weblate-i18n` branch of the main Codeberg repository and creates or updates a pull request (PR) to `master`. This operation can be manually triggered via _Manage → Repository Maintenance → Push_.
|
||||
After committing changes from the internal database to the internal repository, Weblate pushes all updates to the `weblate-i18n` branch of the main Codeberg repository and creates or updates a pull request (PR) to `main`. This operation can be manually triggered via _Manage → Repository Maintenance → Push_.
|
||||
|
||||
### Reviewing PRs
|
||||
|
||||
@@ -81,41 +81,41 @@ The recommended approach for resolving conflicts is as follows:
|
||||
2. Update the `weblate-i18n` branch on Codeberg:
|
||||
_Manage → Repository Maintenance → Push (button)_.
|
||||
3. Locally checkout the `weblate-i18n` branch.
|
||||
4. Rebase it onto `master`, resolving any conflicts during the process.
|
||||
5. Push the branch to Codeberg to update the pull request, then merge the branch or PR into `master`.
|
||||
4. Rebase it onto `main`, resolving any conflicts during the process.
|
||||
5. Push the branch to Codeberg to update the pull request, then merge the branch or PR into `main`.
|
||||
6. Reset Weblate to sync changes from GitHub:
|
||||
_Manage → Repository Maintenance → Reset (button)_.
|
||||
|
||||
[weblate]: https://hosted.weblate.org/projects/organicmaps/
|
||||
[contribute]: https://docs.weblate.org/en/latest/workflows.html
|
||||
[android_weblate]: https://hosted.weblate.org/projects/organicmaps/android/
|
||||
[android_git]: https://github.com/organicmaps/organicmaps/blob/master/android/app/src/main/res/
|
||||
[android_git_en]: https://github.com/organicmaps/organicmaps/blob/master/android/app/src/main/res/values/strings.xml
|
||||
[android_git]: https://codeberg.org/comaps/comaps/src/branch/main/android/app/src/main/res
|
||||
[android_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/android/app/src/main/res/values/strings.xml
|
||||
[android_typestrings_weblate]: https://hosted.weblate.org/projects/organicmaps/android-typestrings/
|
||||
[android_typestrings_git_en]: https://github.com/organicmaps/organicmaps/blob/master/android/app/src/main/res/values/types_strings.xml
|
||||
[android_typestrings_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/android/app/src/main/res/values/types_strings.xml
|
||||
[countries_weblate]: https://hosted.weblate.org/projects/organicmaps/countries/
|
||||
[countries_git]: https://github.com/organicmaps/organicmaps/tree/master/data/countries-strings
|
||||
[countries_git_en]: https://github.com/organicmaps/organicmaps/blob/master/data/countries-strings/en.json/localize.json
|
||||
[countries_git]: https://codeberg.org/comaps/comaps/src/branch/main/data/countries-strings
|
||||
[countries_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/data/countries-strings/en.json/localize.json
|
||||
[ios_weblate]: https://hosted.weblate.org/projects/organicmaps/ios/
|
||||
[ios_git]: https://github.com/organicmaps/organicmaps/blob/master/iphone/Maps/LocalizedStrings/
|
||||
[ios_git_en]: https://github.com/organicmaps/organicmaps/blob/master/iphone/Maps/LocalizedStrings/en.lproj/Localizable.strings
|
||||
[ios_git]: https://codeberg.org/comaps/comaps/src/branch/main/iphone/Maps/LocalizedStrings/
|
||||
[ios_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/iphone/Maps/LocalizedStrings/en.lproj/Localizable.strings
|
||||
[ios_plist_weblate]: https://hosted.weblate.org/projects/organicmaps/ios-plist/
|
||||
[ios_plist_git_en]: https://github.com/organicmaps/organicmaps/blob/master/iphone/Maps/LocalizedStrings/en.lproj/InfoPlist.strings
|
||||
[ios_plist_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/iphone/Maps/LocalizedStrings/en.lproj/InfoPlist.strings
|
||||
[ios_typestrings_weblate]: https://hosted.weblate.org/projects/organicmaps/ios-typestrings/
|
||||
[ios_typestrings_git_en]: https://github.com/organicmaps/organicmaps/blob/master/iphone/Maps/LocalizedStrings/en.lproj/LocalizableTypes.strings
|
||||
[ios_typestrings_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/iphone/Maps/LocalizedStrings/en.lproj/LocalizableTypes.strings
|
||||
[ios_plurals_weblate]: https://hosted.weblate.org/projects/organicmaps/ios-plurals/
|
||||
[ios_plurals_git_en]: https://github.com/organicmaps/organicmaps/blob/master/iphone/Maps/LocalizedStrings/en.lproj/Localizable.stringsdict
|
||||
[ios_plurals_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/iphone/Maps/LocalizedStrings/en.lproj/Localizable.stringsdict
|
||||
[tts_weblate]: https://hosted.weblate.org/projects/organicmaps/tts/
|
||||
[tts_git]: https://github.com/organicmaps/organicmaps/tree/master/data/sound-strings
|
||||
[tts_git_en]: https://github.com/organicmaps/organicmaps/blob/master/data/sound-strings/en.json/localize.json
|
||||
[categories_git]: https://github.com/organicmaps/organicmaps/blob/master/data/categories.txt
|
||||
[categories_cuisines_git]: https://github.com/organicmaps/organicmaps/blob/master/data/categories_cuisines.txt
|
||||
[tts_git]: https://codeberg.org/comaps/comaps/src/branch/main/data/sound-strings
|
||||
[tts_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/data/sound-strings/en.json/localize.json
|
||||
[categories_git]: https://codeberg.org/comaps/comaps/src/branch/main/data/categories.txt
|
||||
[categories_cuisines_git]:https://codeberg.org/comaps/comaps/src/branch/main/data/categories_cuisines.txt
|
||||
[website_weblate]: https://hosted.weblate.org/projects/organicmaps/website/
|
||||
[website_git]: https://github.com/organicmaps/website/
|
||||
[website_guide]: https://github.com/organicmaps/website/blob/master/TRANSLATIONS.md
|
||||
[appstore_git]: https://github.com/organicmaps/organicmaps/tree/master/iphone/metadata
|
||||
[appstore_git_en]: https://github.com/organicmaps/organicmaps/tree/master/iphone/metadata/en-US
|
||||
[googleplay_git]: https://github.com/organicmaps/organicmaps/tree/master/android/app/src/fdroid/play
|
||||
[googleplay_git_en]: https://github.com/organicmaps/organicmaps/tree/master/android/app/src/fdroid/play/listings/en-US
|
||||
[mergers]: https://github.com/orgs/organicmaps/teams/mergers/members
|
||||
[website_git]: https://codeberg.org/comaps/website/
|
||||
[website_guide]: https://codeberg.org/comaps/website/src/branch/main/TRANSLATIONS.md
|
||||
[appstore_git]: https://codeberg.org/comaps/comaps/src/branch/main/iphone/metadata
|
||||
[appstore_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/iphone/metadata/en-US
|
||||
[googleplay_git]: https://codeberg.org/comaps/comaps/src/branch/main/android/app/src/fdroid/play
|
||||
[googleplay_git_en]: https://codeberg.org/comaps/comaps/src/branch/main/android/app/src/fdroid/play/listings/en-US
|
||||
[mergers]: https://codeberg.org/org/comaps/teams
|
||||
[failing_checks]: https://hosted.weblate.org/search/organicmaps/?q=has%3Acheck+AND+state%3A%3E%3Dtranslated+language%3Aru&sort_by=target&checksum=
|
||||
|
||||
Reference in New Issue
Block a user