Skip to content

Commit 56ad3a4

Browse files
First commit
0 parents  commit 56ad3a4

File tree

499 files changed

+107410
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

499 files changed

+107410
-0
lines changed

.github/pull_request_template.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*
2+
3+
## Pre-launch Checklist
4+
5+
- [ ] I read the [Contributor Guide](CONTRIBUTING.md) and followed the process outlined there for submitting PRs.
6+
- If you made changes to the code:
7+
- [ ] I added new tests to check the change I am making or feature I am adding.
8+
- [ ] All existing and new tests are passing.

.github/workflows/flutter_test.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Flutter Test CI
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: subosito/flutter-action@v1.4.0
13+
with:
14+
flutter-version: '2.2.x'
15+
- name: Disable Google Analytics
16+
run: flutter config --no-analytics
17+
- name: Install dependencies
18+
run: flutter pub get
19+
- name: Analyze code
20+
run: flutter analyze
21+
- name: Run tests
22+
run: flutter test test

.gitignore

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Miscellaneous
2+
*.class
3+
*.log
4+
*.pyc
5+
*.swp
6+
.DS_Store
7+
.atom/
8+
.buildlog/
9+
.history
10+
.svn/
11+
12+
# IntelliJ related
13+
*.iml
14+
*.ipr
15+
*.iws
16+
.idea/
17+
18+
# The .vscode folder contains launch configuration and tasks you configure in
19+
# VS Code which you may wish to be included in version control, so this line
20+
# is commented out by default.
21+
#.vscode/
22+
23+
# Flutter/Dart/Pub related
24+
**/doc/api/
25+
.dart_tool/
26+
.flutter-plugins
27+
.flutter-plugins-dependencies
28+
.packages
29+
.pub-cache/
30+
.pub/
31+
/build/
32+
33+
# Web related
34+
lib/generated_plugin_registrant.dart
35+
36+
# Symbolication related
37+
app.*.symbols
38+
39+
# Obfuscation related
40+
app.*.map.json
41+
42+
# Exceptions to above rules.
43+
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
44+
45+
# Envinronment
46+
.env
47+
.env_test

.metadata

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# This file tracks properties of this Flutter project.
2+
# Used by Flutter tool to assess capabilities and perform upgrades etc.
3+
#
4+
# This file should be version controlled and should not be manually edited.
5+
6+
version:
7+
revision: 1ad9baa8b99a2897c20f9e6e54d3b9b359ade314
8+
channel: stable
9+
10+
project_type: app

.vscode/launch.json

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "Flutter Debug",
9+
"request": "launch",
10+
"type": "dart",
11+
"flutterMode": "debug",
12+
"args": ["--flavor", "main"],
13+
},
14+
{
15+
"name": "Flutter Release",
16+
"request": "launch",
17+
"type": "dart",
18+
"flutterMode": "release",
19+
"args": ["--flavor", "main"]
20+
},
21+
{
22+
"name": "Flutter Profile",
23+
"request": "launch",
24+
"type": "dart",
25+
"flutterMode": "profile",
26+
"args": ["--flavor", "main"]
27+
},
28+
{
29+
"name": "Flutter: Attach to Device",
30+
"type": "dart",
31+
"request": "attach"
32+
},
33+
{
34+
"name": "Flutter: Run all Tests",
35+
"type": "dart",
36+
"request": "launch",
37+
"program": "./test/"
38+
},
39+
],
40+
}

CONTRIBUTING.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Contributor Guide
2+
=====================
3+
4+
## 🌍 Note for translators
5+
6+
Localization files are located in the [lib/l10n](lib/l10n) directory.
7+
8+
The app uses ARB format for localization. If you wonder how to format key-values content inside ARB files, [here](https://github.com/google/app-resource-bundle/wiki/ApplicationResourceBundleSpecification) is detailed explanation.
9+
10+
If you are making changes to the localization files, run the following command:
11+
```
12+
flutter pub run intl_utils:generate
13+
```
14+
15+
If you added a new language, make sure to add it to the [lib/locale.dart](lib/locale.dart).
16+
17+
Detailed documentation on `intl_utils` [here](https://pub.dev/packages/intl_utils).
18+
19+
## ⚙️ How to make changes in the code
20+
21+
### 1. Where to begin
22+
23+
Start by looking at the [open issues](https://github.com/proninyaroslav/libretrack/issues) to contribute code.
24+
25+
Make sure to write your name and e-mail address in format `Name <e-mail>` in the license declaration above every file you make changes to.
26+
27+
Repeat and rinse, if you send enough patches to demonstrate you have a good coding skills, you will be given commit access on the real repo, making you part of the development team.
28+
29+
Also, take a look at [**Coding Guidelines**](#-coding-guidelines) before making code changes.
30+
31+
### 2. After making changes
32+
33+
Be sure to run `build_runner` before creating your commit:
34+
```
35+
flutter pub run build_runner build --delete-conflicting-outputs
36+
```
37+
38+
Detailed documentation on `build_runner` [here](https://pub.dev/packages/build_runner).
39+
40+
If you are making changes to the localization files, also read the [Note for translators](#-note-for-translators) section.
41+
42+
### 3. Testing
43+
44+
Make sure that all existing and new tests are passing:
45+
```
46+
flutter test test
47+
```
48+
49+
## 📋 Coding Guidelines
50+
51+
- Keep it snimple snupid: [KISS](https://en.wikipedia.org/wiki/KISS_principle)
52+
- No repeating yourself. [Re-use your own code and that of others](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).
53+
- If you want to help, triaging and keeping up with the issue and TODO list is great.
54+
- Try to follow our coding style and formatting before submitting a patch.
55+
- All merge requests should come from a feature branch created on your Git fork. Your code will be reviewed, and only merged to the master branch if it doesn't break the build.
56+
- When you submit a merge request, try to explain what issue you're fixing, and what you're fixing in detail, so it's easier for us to read your patches.
57+
- Well named methods and code re-usability is preferable to a lot of comments.

0 commit comments

Comments
 (0)