Skip to content

Commit

Permalink
Initial structure + tests
Browse files Browse the repository at this point in the history
  • Loading branch information
mvanbeusekom committed May 28, 2020
0 parents commit cfbf2f2
Show file tree
Hide file tree
Showing 109 changed files with 3,611 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# This file is understood by git 1.7.2+.

# Windows specific files should always be crlf on checkout
*.bat text eol=crlf
*.cmd text eol=crlf
*.ps1 text eol=crlf

# Check out the following as ln always for osx/linux/cygwin
*.sh text eol=lf

# Opt in the following types to always normalize line endings
# on checkin and always use native endings on checkout.
*.config text
*.cs text diff=csharp
*.csproj text
*.md text
*.msbuild text
*.nuspec text
*.pp text
*.ps1 text
*.sln text
*.tt text
*.txt text
*.xaml text
*.xml text

# Binary files
*.bmp binary
*.jpeg binary
*.jpg binary
*.nupkg binary
*.png binary
*.sdf binary

*.java linguist-language=Dart
*.kt linguist-language=Dart
*.swift linguist-language=Dart
*.m linguist-language=Dart
*.h linguist-language=Dart
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: Baseflow
custom: https://baseflow.com/contact
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/a-regression.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---

name: 🔙 Regression
about: Report unexpected behavior that worked previously
---

## 🔙 Regression

<!--- Summary description of the regression --->

### Old (and correct) behavior

### Current behavior

### Reproduction steps

### Configuration

**Version:** 1.x

**Platform:**
- [ ] :iphone: iOS
- [ ] :robot: Android
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/b-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---

name: 🐛 Bug Report
about: Create a report to help us fix bugs and make improvements
---

## 🐛 Bug Report

<!--- Summary description of the bug --->

### Expected behavior

### Reproduction steps

### Configuration

**Version:** 1.x

**Platform:**
- [ ] :iphone: iOS
- [ ] :robot: Android
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/c-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---

name: 🚀 Feature Request
about: Want to see something new included in the Framework? Submit it!
---

## 🚀 Feature Requests

<!--- Summary description of the feature --->

### Contextualize the feature
<!--- Where does it fit in the framework and why it's being included there. --->

### Describe the feature
<!--- Use as much detail as possible here! --->

### Platforms affected (mark all that apply)
- [ ] :iphone: iOS
- [ ] :robot: Android
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/d-enhancement-proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---

name: 🏗 Enhancement Proposal
about: Proposals for code cleanup, refactor and improvements in general
---

## 🏗 Enhancement Proposal

<!--- A clear and concise description for your idea --->

### Pitch

<!--- How will this refactor improve contributors' lives? Input as many details as possible! --->

### Platforms affected (mark all that apply)
- [ ] :iphone: iOS
- [ ] :robot: Android
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/e-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---

name: 💬 Questions and Help
about: If you have questions, please use this for support
---

## 💬 Questions and Help

For questions or help we recommend checking:

- The [Flutter tag in Stack Overflow](https://stackoverflow.com/questions/tagged/flutter)
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### :sparkles: What kind of change does this PR introduce? (Bug fix, feature, docs update...)


### :arrow_heading_down: What is the current behavior?


### :new: What is the new behavior (if this is a feature change)?


### :boom: Does this PR introduce a breaking change?


### :bug: Recommendations for testing


### :memo: Links to relevant issues/docs


### :thinking: Checklist before submitting

- [ ] All projects build
- [ ] Follows style guide lines ([code style guide](https://github.com/Baseflow/flutter-geocoder/blob/master/CONTRIBUTING.md))
- [ ] Relevant documentation was updated
- [ ] Rebased onto current develop
98 changes: 98 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Miscellaneous
*.class
*.lock
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.project
.svn/
bin/
coverage/

# IntelliJ related
*.iml
*.ipr
*.iws
.idea/

# Android Studio related
android/.classpath
android/.settings/
example/android/.settings/

# Visual Studio Code related
.vscode/

# Flutter repo-specific
/bin/cache/
/bin/mingit/
/dev/benchmarks/mega_gallery/
/dev/bots/.recipe_deps
/dev/bots/android_tools/
/dev/docs/doc/
/dev/docs/lib/
/dev/docs/pubspec.yaml
/packages/flutter/coverage/
version

# Flutter/Dart/Pub related
**/doc/api/
.dart_tool/
.flutter-plugins
.packages
.pub-cache/
.pub/
build/
flutter_*.png
linked_*.ds
unlinked.ds
unlinked_spec.ds
flutter_export_environment.sh
**/.flutter-plugins-dependencies

# Android related
**/android/**/gradle-wrapper.jar
**/android/.gradle
**/android/captures/
**/android/gradlew
**/android/gradlew.bat
**/android/local.properties
**/android/**/GeneratedPluginRegistrant.java

# iOS/XCode related
**/ios/**/*.mode1v3
**/ios/**/*.mode2v3
**/ios/**/*.moved-aside
**/ios/**/*.pbxuser
**/ios/**/*.perspectivev3
**/ios/**/*sync/
**/ios/**/.sconsign.dblite
**/ios/**/.tags*
**/ios/**/.vagrant/
**/ios/**/DerivedData/
**/ios/**/Icon?
**/ios/**/Pods/
**/ios/**/.symlinks/
**/ios/**/profile
**/ios/**/xcuserdata
**/ios/.generated/
**/ios/Flutter/App.framework
**/ios/Flutter/Flutter.framework
**/ios/Flutter/Generated.xcconfig
**/ios/Flutter/app.flx
**/ios/Flutter/app.zip
**/ios/Flutter/flutter_assets/
**/ios/ServiceDefinitions.json
**/ios/Runner/GeneratedPluginRegistrant.*
**/ios/Flutter/Flutter.podspec

# Exceptions to above rules.
!**/ios/**/default.mode1v3
!**/ios/**/default.mode2v3
!**/ios/**/default.pbxuser
!**/ios/**/default.perspectivev3
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 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]](mailto:[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 [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Contributing to the Flutter Geolocator plugin
=============================================

What you will need
------------------

* A Linux, Mac OS X, or Windows machine (note: to run and compile iOS specific parts you'll need access to a Mac OS X machine);
* git (used for source version control, installation instruction can be found [here](https://git-scm.com/));
* The Flutter SDK (installation instructions can be found [here](https://flutter.io/get-started/install/));
* A personal GitHub account (if you don't have one, you can sign-up for free [here](https://github.com/))

Setting up your development environment
---------------------------------------

* Fork `https://github.com/BaseflowIT/flutter-geolocator` into your own GitHub account. If you already have a fork and moving to a new computer, make sure you update you fork.
* If you haven't configured your machine with an SSH key that's known to github, then
follow [GitHub's directions](https://help.github.com/articles/generating-ssh-keys/)
to generate an SSH key.
* Clone your forked repo on your local development machine: `git clone [email protected]:<your_name_here>/flutter-geolocator.git`
* Change into the `flutter-geolocator` directory: `cd flutter-geolocator`
* Add an upstream to the original repo, so that fetch from the master repository and not your clone: `git remote add upstream [email protected]:BaseflowIT/flutter-geolocator.git`

Running the example project
---------------------------

* Change into the example directory: `cd example`
* Run the App: `flutter run`

Contribute
----------

We really appreciate contributions via GitHub pull requests. To contribute take the following steps:

* Make sure you are up to date with the latest code on the master:
* `git fetch upstream`
* `git checkout upstream/develop -b <name_of_your_branch>`
* Apply your changes
* Verify your changes and fix potential warnings/ errors:
* Check formatting: `flutter format .`
* Run static analyses: `flutter analyze`
* Run unit-tests: `flutter test`
* Commit your changes: `git commit -am "<your informative commit message>"`
* Push changes to your fork: `git push origin <name_of_your_branch>`

Send us your pull request:

* Go to `https://github.com/BaseflowIT/flutter-geolocator` and click the "Compare & pull request" button.

Please make sure you solved all warnings and errors reported by the static code analyses and that you fill in the full pull request template. Failing to do so will result in us asking you to fix it.
Loading

0 comments on commit cfbf2f2

Please sign in to comment.