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

Complete Readme, added contribution guidelines (incomplete, todo) #3

This commit is contained in:
Michael Gordeev
2020-01-28 03:25:53 +03:00
parent 3c32b3d387
commit 1c80fa20f6
2 changed files with 107 additions and 1 deletions
+23 -1
View File
@@ -10,7 +10,29 @@
## Overview
Android application which exports SPbSUT timetable to calendar
It uses C# v8.0 programming language and Xamarin.Android platform. Minimal Android version: 4.1
- Programming language: C# 8.0
- Platform: Xamarin.Android
- Minimal Android version: 4.1 (API level 16 - Jelly Bean)
- Target Android version: 9.0 (API level 28 - Pie)
## Contributing
There are many ways in which you can participate in the project, for example:
- [Submit bugs and feature requests](https://github.com/xfox111/gutschedule/issues), and help us verify as they are checked in
- Review [source code changes](https://github.com/xfox111/gutschedule/pulls)
- Review documentation and make pull requests for anything from typos to new content
If you are interested in fixing issues and contributing directly to the code base, please see the [Contribution Guidelines](https://github.com/XFox111/GUTSchedule/blob/master/CONTRIBUTION.md), which covers the following:
- [How to build and run from source](https://github.com/XFox111/GUTSchedule/CONTRIBUTION.md#build-and-run-project)
- [The development workflow](https://github.com/XFox111/GUTSchedule/CONTRIBUTION.md#development-workflow), including debugging and running tests
- [Coding guidelines](https://github.com/XFox111/GUTSchedule/CONTRIBUTION.md#coding-guidelines)
- [Submitting pull requests](https://github.com/XFox111/GUTSchedule/CONTRIBUTION.md#submitting-pull-requests)
- [Finding an issue to work on](https://github.com/XFox111/GUTSchedule/CONTRIBUTION.md#finding-an-issue-to-work-on)
- [Contributing to translations](https://github.com/XFox111/GUTSchedule/CONTRIBUTION.md#contributing-to-translations)
## Code of Conduct
This project has adopted the Contributor Covenant. For more information see the [GUTSchedule Code of Conduct](https://github.com/XFox111/GUTSchedule/blob/master/CODE_OF_CONDUCT.md)
## Copyrights
> ©2020 Michael "XFox" Gordeev
Licensed under [General Public License v3](https://www.gnu.org/licenses/gpl-3.0)