This repository has been archived by the owner on Aug 13, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
646 changed files
with
13,922 additions
and
20,708 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
[*.{kt,kts}] | ||
indent_size=4 | ||
continuation_indent_size=8 | ||
insert_final_newline=true | ||
max_line_length=120 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
**Issue:** [AN-<ID>: <name>](<link to Jira>) | ||
|
||
|
||
## Description | ||
<!-- A few sentences describing the overall goals of the pull request's commits. | ||
What is the current behavior of the app? What is the updated/expected behavior with this PR? --> | ||
|
||
|
||
|
||
|
||
## Checklist | ||
<!-- Check all items that apply using "x" --> | ||
|
||
- [ ] Tested on actual devices | ||
- [ ] Commit messages follow conventionalcommits.org | ||
|
||
|
||
<!-- If this PR is complete, please add the label `PR: ready for merge` from the right. --> | ||
|
||
|
||
<!-- Add this section if you need it. | ||
## Before & After Screenshots | ||
| Description 1 | Description 2 | Description 3 | | ||
| :------------: | :------------: | :------------: | | ||
| <screenshot 1> | <screenshot 2> | <screenshot 3> | | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct/ | ||
|
||
[homepage]: https://www.contributor-covenant.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Contributing | ||
|
||
Please feel free to help us with the ongoing development of this app. See open [issues] to get some inspiration and open a Pull Request as soon as you are ready to go. | ||
|
||
Some issues are tagged with [🐶beginner friendly](https://ticketsystem.schul-cloud.org/browse/AN-1?jql=project%20%3D%20AN%20AND%20resolution%20%3D%20Unresolved%20AND%20Difficulty%20%3D%20%22%F0%9F%90%B6beginner%20friendly%22%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC) to get you started! | ||
|
||
- [Contributing](#contributing) | ||
- [1. Clone the project](#1-clone-the-project) | ||
- [2. How to name your branch](#2-how-to-name-your-branch) | ||
- [3. Getting started](#3-getting-started) | ||
- [4. Creating a pull request](#4-creating-a-pull-request) | ||
|
||
|
||
## 1. Clone the project | ||
|
||
Clone the git repository: | ||
|
||
```git | ||
git clone --recursive https://github.com/schul-cloud/schulcloud-mobile-android | ||
``` | ||
|
||
|
||
## 2. How to name your branch | ||
|
||
You first need to start a new branch. As a base you can either **choose the `dev` branch**, or another issue-branch that was recently developed but not yet merged. You should normally choose the former, except there is a super cool new feature which you want to improve. However, don't base your branch on master, as it contains the latest stable release and might be outdated. | ||
|
||
To name your branch, take the number of the Jira-issue and append the issue name in lowercase, replacing spaces with dashes. | ||
|
||
**Example:** Issue [AN-2](https://ticketsystem.schul-cloud.org/browse/AN-2), "Add styleguide for coding" becomes branch _2-add-styleguide-for-coding_ | ||
|
||
|
||
## 3. Getting started | ||
|
||
We have documented the underlaying architecture of our app in the [architecture] file. It also contains code snippets for common features, such as embedding a `SwipeRefreshLayout` with only three lines of code or showing a progress dialog with just one line. | ||
|
||
When commiting, please use [conventional commits]. This makes it much easier to get an overview of what you did. | ||
|
||
|
||
## 4. Creating a pull request | ||
|
||
Before you create a pull request, please enter a short description of what changed in our [changelog] (*Unreleased* section). | ||
|
||
For writing the PR message and details on what to include, please use our [Pull Request template][pr-template]. | ||
|
||
|
||
[android studio]: https://developer.android.com/studio/ | ||
[conventional commits]: https://conventionalcommits.org/ | ||
[architecture]: ./architecture.md | ||
[changelog]: ./CHANGELOG.md | ||
[issues]: https://ticketsystem.schul-cloud.org/projects/AN/issues | ||
[pr-template]: ./.github/PULL_REQUEST_TEMPLATE.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# github comment settings | ||
github.dismiss_out_of_range_messages | ||
|
||
# for PR | ||
if github.pr_title.include?('[WIP]') || github.pr_labels.include?('PR: wip') | ||
warn('PR is classed as Work in Progress') | ||
end | ||
|
||
# Warn when there is a big PR | ||
warn('a large PR') if git.lines_of_code > 500 | ||
|
||
# detekt | ||
checkstyle_format.base_path = Dir.pwd | ||
checkstyle_format.report 'app/build/reports/detekt/detekt-checkstyle.xml' | ||
|
||
# AndroidLint | ||
android_lint.report_file = "app/build/reports/lint-results.xml" | ||
android_lint.skip_gradle_task = true | ||
android_lint.severity = "Error" | ||
android_lint.lint(inline_mode: true) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# frozen_string_literal: true | ||
source "http://rubygems.org" | ||
|
||
gem 'danger' | ||
gem 'danger-checkstyle_format' | ||
gem 'danger-android_lint' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
GEM | ||
remote: http://rubygems.org/ | ||
specs: | ||
addressable (2.5.2) | ||
public_suffix (>= 2.0.2, < 4.0) | ||
ansi (1.5.0) | ||
ast (2.4.0) | ||
claide (1.0.2) | ||
claide-plugins (0.9.2) | ||
cork | ||
nap | ||
open4 (~> 1.3) | ||
colored2 (3.1.2) | ||
cork (0.3.0) | ||
colored2 (~> 3.1) | ||
danger (5.6.2) | ||
claide (~> 1.0) | ||
claide-plugins (>= 0.9.2) | ||
colored2 (~> 3.1) | ||
cork (~> 0.1) | ||
faraday (~> 0.9) | ||
faraday-http-cache (~> 1.0) | ||
git (~> 1) | ||
kramdown (~> 1.5) | ||
no_proxy_fix | ||
octokit (~> 4.7) | ||
terminal-table (~> 1) | ||
danger-android_lint (0.0.6) | ||
danger-plugin-api (~> 1.0) | ||
oga | ||
danger-checkstyle_format (0.1.1) | ||
danger-plugin-api (~> 1.0) | ||
ox (~> 2.0) | ||
danger-plugin-api (1.0.0) | ||
danger (> 2.0) | ||
faraday (0.15.2) | ||
multipart-post (>= 1.2, < 3) | ||
faraday-http-cache (1.3.1) | ||
faraday (~> 0.8) | ||
git (1.4.0) | ||
kramdown (1.17.0) | ||
multipart-post (2.0.0) | ||
nap (1.1.0) | ||
no_proxy_fix (0.1.2) | ||
octokit (4.9.0) | ||
sawyer (~> 0.8.0, >= 0.5.3) | ||
oga (2.15) | ||
ast | ||
ruby-ll (~> 2.1) | ||
open4 (1.3.4) | ||
ox (2.9.4) | ||
public_suffix (3.0.2) | ||
ruby-ll (2.1.2) | ||
ansi | ||
ast | ||
sawyer (0.8.1) | ||
addressable (>= 2.3.5, < 2.6) | ||
faraday (~> 0.8, < 1.0) | ||
terminal-table (1.8.0) | ||
unicode-display_width (~> 1.1, >= 1.1.1) | ||
unicode-display_width (1.4.0) | ||
|
||
PLATFORMS | ||
x64-mingw32 | ||
|
||
DEPENDENCIES | ||
danger | ||
danger-android_lint | ||
danger-checkstyle_format | ||
|
||
BUNDLED WITH | ||
1.16.3 |
Oops, something went wrong.