xfox111/GUTSchedule
1
0
Fork 0
mirror of https://github.com/XFox111/GUTSchedule.git synced 2026-04-22 06:58:01 +03:00
Code Activity

Updated documentation

Browse Source
This commit is contained in:
Michael Gordeev
2020-02-12 01:56:26 +03:00
parent 35af57e033
commit 452967ac38
3 changed files with 47 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/bug_report.md
+4 -3
View File
@@ -25,9 +25,10 @@ If applicable, add screenshots to help explain your problem.
### Environment ### Environment
Please complete the following information: Please complete the following information:
- Device: [e.g. Google Pixel 3 XL] - Platform: [e.g. Windows 10 Pro]
- Android OS version: [e.g. 7.1] - Device: [e.g. Microsoft Surface Pro 6]
- Application version: [e.g. 1.0.1] - OS version: [e.g. 1909 (10.0.18363)]
- Application version: [e.g. 20200202.1]
### Additional context ### Additional context
Add any other context about the problem here. Add any other context about the problem here.
CONTRIBUTING.md
+34 -10
View File
@@ -87,13 +87,26 @@ If you are interested in writing code to fix issues or implement new awesome fea
git clone https://github.com/xfox111/GUTSchedule.git git clone https://github.com/xfox111/GUTSchedule.git
``` ```
2. Open `GUT.Schedule/GUT.Schedule.sln` using [Microsoft Visual Studio](https://visualstudio.microsoft.com/) 2019 or later 2. Open `GUT.Schedule/GUT.Schedule.sln` using [Microsoft Visual Studio](https://visualstudio.microsoft.com/) 2019 or later
- Make sure you have properly installed and congigured [Xamarin.Android](https://docs.microsoft.com/en-us/xamarin/android/get-started/installation/) environment - Make sure you have properly installed and congigured [Xamarin.Android](https://docs.microsoft.com/en-us/xamarin/android/get-started/installation/) and UWP development environments
3. On the VS toolbar choose build configuration:
**Android**
1. In `Solution Explorer` right-click `GUTSchedule.Droid` project and click `Set as StartUp Project`
2. On the VS toolbar choose build configuration:
- `Debug` for building and deploying test version of the app - `Debug` for building and deploying test version of the app
- `Release` for building final version of application and creating AppBundle package (.aab) - `Release` for building final version of application and creating AppBundle package (.aab)
- `Release (APK)` for building final version of application and creating Android package fike (.apk) - `Release (APK)` for building final version of application and creating Android package fike (.apk)
4. To ensure that code compiles go to `Build -> Build Solution` 3. To ensure that code compiles go to `Build -> Build Solution`
5. [Debug application](https://docs.microsoft.com/en-us/xamarin/android/deploy-test/debugging/) on an actual device or Android Emulator 4. [Debug application](https://docs.microsoft.com/en-us/xamarin/android/deploy-test/debugging/) on an actual device or Android Emulator
**UWP**
1. In `Solution Explorer` right-click `GUTSchedule.UWP (Universal Windows)` project and click `Set as StartUp Project`
2. On the VS toolbar choose build configuration:
- `Debug` for building and deploying test version of the app
- `Release` for building final version of application and creating Appx packages
3. To ensure that code compiles go to `Build -> Build Solution`
4. [Debug application](https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/deploying-and-debugging-uwp-apps) on your machine or Windows Device Emulator
### Development workflow ### Development workflow
This section represents how contributors should interact with codebase implementing features and fixing bugs This section represents how contributors should interact with codebase implementing features and fixing bugs
@@ -241,19 +254,30 @@ To avoid multiple pull requests resolving the same issue, let others know you ar
### Contributing to translations ### Contributing to translations
If you want to help us to translate this application into other languages you can do it making these steps: If you want to help us to translate this application into other languages you can do it making these steps:
1. Navigate to `GUT.Schedule/GUT.Schedule/Resources` **Android**
1. Navigate to `GUT.Schedule/GUTSchedule.Droid/Resources`
2. Create new folder named `values-lc` where `lc` is locale language. 2. Create new folder named `values-lc` where `lc` is locale language.
Folder name examples: Folder name examples:
- `values-uk` for Ukrainian - `values-uk` for Ukrainian
- `values-be` for Belarusian - `values-be` for Belarusian
- `values-ru` for Russian - `values-ru` for Russian
> **Note** that we only accept region neutral localizations (e.g. pull request with `values-en-rUS` (English (United States)) folder will be rejected whether PR with `values-en` (English (Invarian Country)) folder will be accepted).
For reference, here is a [list of Java locales](https://www.oracle.com/technetwork/java/javase/locales-137662.html) and [Android-supported locales via StackOverflow](https://stackoverflow.com/questions/7973023/what-is-the-list-of-supported-languages-locales-on-android). For reference, here is a [list of Java locales](https://www.oracle.com/technetwork/java/javase/locales-137662.html) and [Android-supported locales via StackOverflow](https://stackoverflow.com/questions/7973023/what-is-the-list-of-supported-languages-locales-on-android).
3. In the folder copy `strings.xml` file from `GUT.Schedule/GUT.Schedule/Resources/values`
3. In the folder copy `strings.xml` file from `GUT.Schedule/GUTSchedule.Droid/Resources/values`
**UWP**
1. Navigate to `GUT.Schedule/GUTSchedule.UWP/Strings`
2. Clone the folder you want to base your localization on and change its name to match desired localization language. See [Globalization and localization](https://docs.microsoft.com/en-us/windows/uwp/design/globalizing/globalizing-portal) for more information
3. Open `.resw` files from the folder in Visual Studio or other text editor
***
4. Edit localization strings 4. Edit localization strings
5. Commit changes and create a pull request 5. Commit changes and create a pull request
> **Note** that we only accept region neutral localizations (e.g. pull request with `values-en-rUS` (English (United States)) folder will be rejected whether PR with `values-en` (English) folder will be accepted).
### Submitting pull requests ### Submitting pull requests
To enable us to quickly review and accept your pull requests, always create one pull request per issue and [link the issue in the pull request](https://github.com/blog/957-introducing-issue-mentions). Never merge multiple requests in one unless they have the same root cause. Be sure to follow our [Coding Guidelines](#coding-guidelines) and keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain tests whenever possible. Fill pull request content according to its template. Deviations from template are not recommended To enable us to quickly review and accept your pull requests, always create one pull request per issue and [link the issue in the pull request](https://github.com/blog/957-introducing-issue-mentions). Never merge multiple requests in one unless they have the same root cause. Be sure to follow our [Coding Guidelines](#coding-guidelines) and keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain tests whenever possible. Fill pull request content according to its template. Deviations from template are not recommended
README.md
+9 -5
View File
@@ -6,17 +6,21 @@
[![GitHub issues](https://img.shields.io/github/issues/xfox111/GUTSchedule)](https://github.com/xfox111/GUTSchedule/issues) [![GitHub issues](https://img.shields.io/github/issues/xfox111/GUTSchedule)](https://github.com/xfox111/GUTSchedule/issues)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
![GitHub repo size](https://img.shields.io/github/repo-size/xfox111/GUTSchedule?label=Repository%20size) ![GitHub repo size](https://img.shields.io/github/repo-size/xfox111/GUTSchedule?label=Repository%20size)
![Platforms](https://img.shields.io/badge/platforms-android-lightgrey) ![Platforms](https://img.shields.io/badge/platforms-android,%20UWP-lightgrey)
[![Twitter Follow](https://img.shields.io/twitter/follow/xfox111?style=social)](https://twitter.com/xfox111) [![Twitter Follow](https://img.shields.io/twitter/follow/xfox111?style=social)](https://twitter.com/xfox111)
[![GitHub followers](https://img.shields.io/github/followers/xfox111?label=Follow%20@xfox111&style=social)](https://github.com/xfox111) [![GitHub followers](https://img.shields.io/github/followers/xfox111?label=Follow%20@xfox111&style=social)](https://github.com/xfox111)
## Overview ## Overview
Android application which exports SPbSUT timetable to calendar Cross-platform application which exports SPbSUT timetable to calendar
- Programming language: C# 8.0 - Programming language: C# 8.0
- Platform: Xamarin.Android - Platforms: Xamarin.Android, Universal Windows Platform
- Minimal Android version: 4.1 (API level 16 - Jelly Bean) - Android:
- Target Android version: 9.0 (API level 28 - Pie) - Minimal version: 4.1 (API level 16 - Jelly Bean)
- Target version: 9.0 (API level 28 - Pie)
- UWP:
- Minimal version: 1507 (10.0.10240)
- Target version: 1709 (10.0.16299, Fall Creators Update)
## Contributing ## Contributing
There are many ways in which you can participate in the project, for example: There are many ways in which you can participate in the project, for example: