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:
@@ -0,0 +1,84 @@
|
||||
# GUTSchedule Contribution Guidelines
|
||||
|
||||
Welcome, and thank you for your interest in contributing to my app!
|
||||
|
||||
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
|
||||
|
||||
## Asking Questions
|
||||
|
||||
Have a question? Rather than opening an issue, please ask me directly on opensource@xfox111.net.
|
||||
|
||||
## Providing Feedback
|
||||
|
||||
Your comments and feedback are welcome.
|
||||
You can leave your feedbak on my app on feedback@xfox111.net or leave a review on [Google Play](https://play.google.com/store/apps/details?id=com.xfox111.gut.schedule)
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
Have you identified a reproducible problem in the application? Have a feature request? I'd like to hear it! Here's how you can make reporting your issue as effective as possible.
|
||||
|
||||
### Look For an Existing Issue
|
||||
|
||||
Before you create a new issue, please do a search in [open issues](https://github.com/xfox111/gutschedule/issues) to see if the issue or feature request has already been filed.
|
||||
|
||||
Be sure to scan through the [feature requests](https://github.com/XFox111/GUTSchedule/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement).
|
||||
|
||||
If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment:
|
||||
|
||||
* 👍 - upvote
|
||||
* 👎 - downvote
|
||||
|
||||
If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
|
||||
|
||||
### Writing Good Bug Reports and Feature Requests
|
||||
|
||||
File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
|
||||
|
||||
Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.
|
||||
|
||||
The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.
|
||||
|
||||
Please include the following with each issue:
|
||||
- Current version of the app
|
||||
- Your current Android version
|
||||
- Reproducible steps (1... 2... 3...) that cause the issue
|
||||
- What you expected to see, versus what you actually saw
|
||||
- Images, animations, or a link to a video showing the issue occurring
|
||||
|
||||
### Final Checklist
|
||||
|
||||
Please remember to do the following:
|
||||
* [ ] Search the issue repository to ensure your report is a new issue
|
||||
* [ ] Separate issues reports
|
||||
* [ ] Include as much information as you can to your report
|
||||
|
||||
Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!
|
||||
|
||||
### Follow Your Issue
|
||||
|
||||
Once your report is submitted, be sure to stay in touch with the devs in case they need more help from you.
|
||||
|
||||
## Contributing Fixes
|
||||
|
||||
If you are interested in writing code to fix issues you can follow this guidelines to get a better result
|
||||
|
||||
> // TODO: Complete guidelines
|
||||
|
||||
### Build and run project
|
||||
|
||||
### Development workflow
|
||||
|
||||
### Coding guidelines
|
||||
|
||||
### Submitting pull requests
|
||||
|
||||
### Finding an issue to work on
|
||||
|
||||
### Contributing to translations
|
||||
|
||||
# Thank You!
|
||||
|
||||
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.
|
||||
|
||||
## Attribution
|
||||
This Contribution Guidelines are adapted from the [Contributing to VS Code](https://github.com/microsoft/vscode/blob/master/CONTRIBUTING.md)
|
||||
@@ -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)
|
||||
Reference in New Issue
Block a user