Merge pull request #34 from flutter-form-builder-ecosystem/33

Add documents and base pipeline

Author: deandreamatias

.flutter-plugins-dependencies

@@ -0,0 +1,21 @@
+## Connection with issue(s)
+
+<!-- If this pull request close some issue, use this reference to close it automatically -->
+Close #???
+
+<!-- Optional: other issues or pull requests related to this, but merging should not close it -->
+Connected to #???
+
+## Solution description
+
+## Screenshots or Videos
+
+<!-- Optional: to clearly demonstrate the feature or fix to help with testing and reviews -->
+
+## To Do
+
+- [ ] Read [contributing guide](https://github.com/flutter-form-builder-ecosystem/form_builder_file_picker/blob/master/CONTRIBUTING.md)
+- [ ] Check the original issue to confirm it is fully satisfied
+- [ ] Add solution description to help guide reviewers
+- [ ] Add unit test to verify new or fixed behaviour
+- [ ] If apply, add documentation to code properties and package readme

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,45 @@
+name: Base
+
+on:
+  push:
+    branches: [main]
+
+  pull_request:
+    branches: [main]
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        channel: [stable, beta]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Check broken links
+        uses: JustinBeckwith/linkinator-action@v1
+        with:
+          paths: "**/*.md"
+
+      - name: Flutter action
+        uses: subosito/flutter-action@v2
+        with:
+          channel: ${{ matrix.channel }}
+
+      - name: Install dependencies
+        run: flutter pub get
+      - name: Format code
+        run: flutter format --dry-run --set-exit-if-changed .
+      - name: Analyze static code
+        run: flutter analyze
+      # - name: Run tests
+      #   run: flutter test
+      - name: Build example
+        run: |
+          cd example
+          flutter build appbundle --debug
+          flutter build ios --debug --no-codesign

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,6 +9,11 @@
 .history
 .svn/
 *.old
+.project
+.classpath
+.settings
+/.fvm
+
 
 # IntelliJ related
 *.iml
@@ -31,6 +36,7 @@
 build/
 coverage/
 lib/generated_plugin_registrant.dart
+.flutter-plugins-dependencies
 # For library packages, don’t commit the pubspec.lock file.
 # Regenerating the pubspec.lock file lets you test your package against the latest compatible versions of its dependencies.
 # See https://dart.dev/guides/libraries/private-files#pubspeclock

.github/workflows/base.yaml

@@ -0,0 +1,133 @@
+
+# Flutter Form Builder Ecosystem Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[Discord server](https://discord.gg/25KNPMJQf2).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.gitignore

@@ -0,0 +1,66 @@
+# Contributing
+
+Thank you for considering and taking the time to contribute to this project!
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with collaborators of this repository before making a change.
+
+Please note we have a [code of conduct](https://github.com/flutter-form-builder-ecosystem/form_builder_file_picker/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## How to Contribute
+
+First setup repository to contribute
+
+If you already setup repository, take a look at the issues and take a stab at them. We'll try to make the issue as verbose as possible, so it is easy for you to help. When you're done, create a [Pull Request](https://github.com/flutter-form-builder-ecosystem/form_builder_file_picker/compare).
+
+You don't need to code to help us. If you have a suggestion of a feature, see a bug or a thing that should be improved, [open an issue](https://github.com/flutter-form-builder-ecosystem/form_builder_file_picker/issues/new/choose) on Github.
+
+
+## Setup development environment
+
+### Copy repository
+
+ * Fork `https://github.com/flutter-form-builder-ecosystem/form_builder_file_picker/` 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 git@github.com:<your_name_here>/.github.git`
+ * Add an upstream to the original repo, so that fetch from the master repository and not your clone: `git remote add upstream git@github.com:flutter-form-builder-ecosystem/.github.git`
+
+### Running the example project
+
+ * Change into the example directory: `cd example`
+ * Run the App: `flutter run`
+
+## Implement code
+
+### Enhancement (new feature or request)
+
+- Implement code
+- Implement unit tests
+- Add example
+- Test example in all package compatible platforms
+- Are a new behaviour; add to readme package
+
+### Bug
+
+- Fix bug
+- Update and/or add unit tests to verify fixed behaviour
+- Verify if bug is fixed all package compatible platforms
+
+## Make a pull request
+
+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 main: 
+   * `git fetch upstream`
+   * `git checkout upstream/main -b <name_of_your_branch>`
+ * Apply your changes
+ * Verify your local changes and fix potential warnings/errors:
+   * Check formatting: `flutter format .`
+   * Run static analyses: `flutter analyze`
+   * Run 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>`
+ * Open a pull request and fill template
+
+ 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.

CODE_OF_CONDUCT.md

@@ -26,7 +26,7 @@ apply plugin: 'kotlin-android'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion flutter.compileSdkVersion
+    compileSdkVersion 33
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
@@ -44,8 +44,8 @@ android {
     defaultConfig {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "dev.formbuilderfilepicker.example"
-        minSdkVersion flutter.minSdkVersion
-        targetSdkVersion flutter.targetSdkVersion
+        minSdkVersion 16
+        targetSdkVersion 33
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }

CONTRIBUTING.md

@@ -21,10 +21,10 @@ class MyHomePage extends StatefulWidget {
   const MyHomePage({Key? key}) : super(key: key);
 
   @override
-  _MyHomePageState createState() => _MyHomePageState();
+  MyHomePageState createState() => MyHomePageState();
 }
 
-class _MyHomePageState extends State<MyHomePage> {
+class MyHomePageState extends State<MyHomePage> {
   final _formKey = GlobalKey<FormBuilderState>();
   bool _useCustomFileViewer = true;