Skip to content

Commit a4af48a

Browse files
OlehMarchOlehMarch
committed
created template for dart packages
1 parent 183a731 commit a4af48a

23 files changed

+533
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: I have a problem with my Flutter application.
3+
about: You are writing an application with Flutter but the application is crashing
4+
or throws an exception, a widget is buggy, or something looks wrong.
5+
title: ''
6+
labels: ''
7+
assignees: ''
8+
9+
---
10+
11+
<!-- Thank you for using Flutter!
12+
13+
If you are looking for support, please check out our documentation
14+
or consider asking a question on Stack Overflow:
15+
* https://flutter.dev/
16+
* https://api.flutter.dev/
17+
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
18+
19+
If you have found a bug or if our documentation doesn't have an answer
20+
to what you're looking for, then fill our the template below. Please read
21+
our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
22+
-->
23+
24+
## Steps to Reproduce
25+
26+
<!-- You must include full steps to reproduce so that we can reproduce the problem. -->
27+
28+
1. Run `flutter create bug`.
29+
2. Update the files as follows: ... <!-- include every file that is different from the template app! -->
30+
3. ... <!-- describe how to reproduce the problem -->
31+
32+
**Expected results:** <!-- what did you want to see? -->
33+
34+
**Actual results:** <!-- what did you see? -->
35+
36+
<details>
37+
<summary>Logs</summary>
38+
39+
<!--
40+
Run your application with `flutter run --verbose` and attach all the
41+
log output below between the lines with the backticks. If there is an
42+
exception, please see if the error message includes enough information
43+
to explain how to solve the issue.
44+
-->
45+
46+
```
47+
```
48+
49+
<!--
50+
Run `flutter analyze` and attach any output of that command below.
51+
If there are any analysis errors, try resolving them before filing this issue.
52+
-->
53+
54+
```
55+
```
56+
57+
<!-- Finally, paste the output of running `flutter doctor -v` here. -->
58+
59+
```
60+
```
61+
62+
</details>

‎.github/ISSUE_TEMPLATE/feature_request.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new idea for Flutter.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Thank you for using Flutter!
11+
12+
If you are looking for support, please check out our documentation
13+
or consider asking a question on Stack Overflow:
14+
* https://flutter.dev/
15+
* https://api.flutter.dev/
16+
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
17+
18+
If you have found a bug or if our documentation doesn't have an answer
19+
to what you're looking for, then fill our the template below. Please read
20+
our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
21+
-->
22+
23+
## Use case
24+
25+
<!--
26+
Please tell us the problem you are running into that led to you wanting
27+
a new feature.
28+
29+
Is your feature request related to a problem? Please give a clear and
30+
concise description of what the problem is.
31+
32+
Describe alternative solutions you've considered. Is there a package
33+
on pub.dev/flutter that already solves this?
34+
-->
35+
36+
## Proposal
37+
38+
<!--
39+
Briefly but precisely describe what you would like Flutter to be able to do.
40+
41+
Consider attaching images showing what you are imagining.
42+
43+
Does this have to be provided by Flutter directly, or can it be provided
44+
by a package on pub.dev/flutter? If so, maybe consider implementing and
45+
publishing such a package rather than filing a bug.
46+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Description
2+
3+
*Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this PR is changing it, and what motivated the change. If you're changing visual properties, consider including before/after screenshots (and runnable code snippets to reproduce them).*
4+
5+
## Related Issues
6+
7+
*Replace this paragraph with a list of issues related to this PR from our issue database. Indicate, which of these issues are resolved or fixed by this PR. There should be at least one issue listed here.*
8+
9+
## Tests
10+
11+
I added the following tests:
12+
13+
*Replace this with a list of the tests that you added as part of this PR. A change in behaviour with no test covering it
14+
will likely get reverted accidentally sooner or later. PRs must include tests for all changed/updated/fixed behaviors. See [Test Coverage].*
15+
16+
## Checklist
17+
18+
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). This will ensure a smooth and quick review process.
19+
20+
- [ ] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
21+
- [ ] I updated/added relevant documentation (doc comments with `///`).
22+
- [ ] All existing and new tests are passing.
23+
- [ ] The analyzer (`flutter analyze --flutter-repo`) does not report any problems on my PR.
24+
- [ ] I am willing to follow-up on review comments in a timely manner.
25+
26+
## Breaking Change
27+
28+
Did any tests fail when you ran them?
29+
30+
- [ ] No, no existing tests failed, so this is *not* a breaking change.
31+
- [ ] Yes, this is a breaking change. *If not, delete the remainder of this section.*
32+
- [ ] I wrote a design doc: https://flutter.dev/go/template *Replace this with a link to your design doc's short link*
33+
- [ ] I got input from the developer relations team, specifically from: *Replace with the names of who gave advice*
34+
- [ ] I wrote a migration guide: *Replace with a link to your migration guide*
35+
36+
<!-- Links -->
37+
[Test Coverage]: https://github.com/flutter/flutter/wiki/Test-coverage-for-package%3Aflutter
38+
[Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
39+
[Features we expect every widget to implement]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#features-we-expect-every-widget-to-implement

‎.github/workflows/dart_build.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: build
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- develop
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-latest
13+
14+
container:
15+
image: google/dart:latest
16+
17+
steps:
18+
- uses: actions/checkout@v2
19+
20+
- name: Install dependencies
21+
run: pub get
22+
23+
- name: Run tests
24+
run: pub run test
25+
26+
# Replace %PROJECT_NAME% to the real project name
27+
28+
# - name: Activate coverage package
29+
# run: pub global activate coverage
30+
31+
# - name: Collect coverage in json
32+
# run: dart --disable-service-auth-codes --enable-vm-service=8111 --pause-isolates-on-exit test/%PROJECT_NAME%_test.dart & nohup pub global run coverage:collect_coverage --port=8111 --out=coverage.json --wait-paused --resume-isolates
33+
34+
# - name: Convert coverage to lcov
35+
# run: pub global run coverage:format_coverage --lcov --in=coverage.json --out=lcov.info --packages=.packages --report-on=lib
36+
37+
# - name: Upload coverage to Codecov
38+
# uses: codecov/[email protected]
39+
# with:
40+
# token: ${{ secrets.CODECOV_TOKEN }}
41+
# flags: unittests
42+
# file: ./lcov.info
43+
# name: codecov-%PROJECT_NAME%

‎.gitignore

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
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+
.packages
28+
.pub-cache/
29+
.pub/
30+
build/
31+
*.lock
32+
33+
# Android related
34+
**/android/**/gradle-wrapper.jar
35+
**/android/.gradle
36+
**/android/captures/
37+
**/android/gradlew
38+
**/android/gradlew.bat
39+
**/android/local.properties
40+
**/android/**/GeneratedPluginRegistrant.java
41+
42+
# iOS/XCode related
43+
**/ios/**/*.mode1v3
44+
**/ios/**/*.mode2v3
45+
**/ios/**/*.moved-aside
46+
**/ios/**/*.pbxuser
47+
**/ios/**/*.perspectivev3
48+
**/ios/**/*sync/
49+
**/ios/**/.sconsign.dblite
50+
**/ios/**/.tags*
51+
**/ios/**/.vagrant/
52+
**/ios/**/DerivedData/
53+
**/ios/**/Icon?
54+
**/ios/**/Pods/
55+
**/ios/**/.symlinks/
56+
**/ios/**/profile
57+
**/ios/**/xcuserdata
58+
**/ios/.generated/
59+
**/ios/Flutter/App.framework
60+
**/ios/Flutter/Flutter.framework
61+
**/ios/Flutter/Flutter.podspec
62+
**/ios/Flutter/Generated.xcconfig
63+
**/ios/Flutter/app.flx
64+
**/ios/Flutter/app.zip
65+
**/ios/Flutter/flutter_assets/
66+
**/ios/Flutter/flutter_export_environment.sh
67+
**/ios/ServiceDefinitions.json
68+
**/ios/Runner/GeneratedPluginRegistrant.*
69+
70+
# Exceptions to above rules.
71+
!**/ios/**/default.mode1v3
72+
!**/ios/**/default.mode2v3
73+
!**/ios/**/default.pbxuser
74+
!**/ios/**/default.perspectivev3
75+
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages

‎.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: 856a90e67c9284124d44d2be6c785bacd3a1c772
8+
channel: dev
9+
10+
project_type: package

‎.vscode/launch.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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": "Example CMD",
9+
"program": "example/bin/main.dart",
10+
"request": "launch",
11+
"type": "dart"
12+
}
13+
]
14+
}

‎AUTHORS

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Below is a list of people and organizations that have contributed
2+
# to the MarchDev Toolkit projects. Names should be added to the list like so:
3+
#
4+
# Name/Organization <email address>
5+
6+
MarchDev Toolkit <[email protected]>
7+
- Oleh Marchenko <[email protected]>
8+
- Elena Marchenko <[email protected]>

‎CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## [1.0.0]
4+
5+
* Add changes here

‎CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)