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 CONTRIBUTING.md: table of contents and build & run

Browse Source
This commit is contained in:
Michael Gordeev
2020-02-03 20:21:52 +03:00
parent fdd02cc105
commit 56654ab147
1 changed files with 33 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+33 -15
View File
@@ -4,21 +4,30 @@ 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. 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.
## Table of Contents ## Table of Contents
- [Introduction](#gutschedule-contribution-guidelines) - [GUTSchedule Contribution Guidelines](#gutschedule-contribution-guidelines)
- [Asking Questions](#asking-questions) - [Table of Contents](#table-of-contents)
- [Providing Feedback](#providing-feedback) - [Asking Questions](#asking-questions)
- [Reporting Issues](#reporting-issues) - [Providing Feedback](#providing-feedback)
- [Reporting Issues](#reporting-issues)
- [Look For an Existing Issue](#look-for-an-existing-issue) - [Look For an Existing Issue](#look-for-an-existing-issue)
- [Writing Good Bug Reports and Feature Requests](#Writing-Good-Bug-Reports-and-Feature-Requests) - [Writing Good Bug Reports and Feature Requests](#writing-good-bug-reports-and-feature-requests)
- [Final Checklist](#Final-Checklist) - [Final Checklist](#final-checklist)
- [Contributing to codebase](#Contributing-to-codebase) - [Follow Your Issue](#follow-your-issue)
- [Build and run project](#Build-and-run-project) - [Contributing to codebase](#contributing-to-codebase)
- [Development workflow](#Development-workflow) - [Build and run project](#build-and-run-project)
- **[Coding guidelines](#Coding-guidelines)** - [Development workflow](#development-workflow)
- [Finding an issue to work on](#Finding-an-issue-to-work-on) - [Coding guidelines](#coding-guidelines)
- [Contributing to translations](#Contributing-to-translations) - [Indentation](#indentation)
- **[Submitting pull requests](#Submitting-pull-requests)** - [Names](#names)
- [Attribution](#Attribution) - [Comments](#comments)
- [Strings](#strings)
- [Style](#style)
- [Finding an issue to work on](#finding-an-issue-to-work-on)
- [Contributing to translations](#contributing-to-translations)
- [Submitting pull requests](#submitting-pull-requests)
- [Spell check errors](#spell-check-errors)
- [Thank You!](#thank-you)
- [Attribution](#attribution)
## Asking Questions ## Asking Questions
Have a question? Rather than opening an issue, please ask me directly on opensource@xfox111.net. Have a question? Rather than opening an issue, please ask me directly on opensource@xfox111.net.
@@ -71,6 +80,15 @@ Once your report is submitted, be sure to stay in touch with the devs in case th
If you are interested in writing code to fix issues or implement new awesome features you can follow this guidelines to get a better result If you are interested in writing code to fix issues or implement new awesome features you can follow this guidelines to get a better result
### Build and run project ### Build and run project
1. Clone repository to local storage using [Git command prompt](https://guides.github.com/introduction/git-handbook/) or [Visual Studio](https://docs.microsoft.com/en-us/visualstudio/get-started/tutorial-open-project-from-repo?view=vs-2019)
2. Open `GUT.Schedule/GUT.Schedule.sln` using [Microsoft Visual Studio](https://visualstudio.microsoft.com/) 2019 or later
3. 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 AppBundle package (.aab)
- `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`
5. To deploy and run application on a device or emulator
6. To build and create new package go to `Build -> Archive...`
> TODO > TODO
### Development workflow ### Development workflow
@@ -218,7 +236,7 @@ To enable us to quickly review and accept your pull requests, always create one
#### Spell check errors #### Spell check errors
Pull requests that fix spell check errors in translatable strings (strings in nls.localize(...) calls) are welcomed but please make sure it doesn't touch multiple feature areas, otherwise it will be difficult to review. Pull requests only fixing spell check errors in source code are not recommended. Pull requests that fix spell check errors in translatable strings (strings in nls.localize(...) calls) are welcomed but please make sure it doesn't touch multiple feature areas, otherwise it will be difficult to review. Pull requests only fixing spell check errors in source code are not recommended.
# Thank You! ## Thank You!
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute. Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.