From b72508d8980e47a927f375c1be2877d6e7b54a63 Mon Sep 17 00:00:00 2001 From: Harry Chen Date: Sun, 29 Dec 2024 11:23:31 +0800 Subject: [PATCH 1/3] doc: add contributing guidelines Signed-off-by: Harry Chen --- CONTRIBUTING.md | 15 +++++++++++++++ README.md | 6 +++++- 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..26ab6bf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +Thanks for your interest in contributing to `flutter_nfc_kit`! + +## GitHub Workflow + +We have two main branches: + +* `develop` branch (default) is for actively development and RC releases. +* `master` branch is for stable releases. + +Both branches are protected. Pull requests are needed for any changes. + +Please always make your changes on `develop` branch, and submit your PR against it. +If there are any merge conflicts, please resolve them by rebasing your commits. diff --git a/README.md b/README.md index eceb9c5..f48442c 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ Note that due to API limitations, not all operations are supported on all platfo This library uses [ndef](https://pub.dev/packages/ndef) for NDEF record encoding & decoding. +## Contributing + +Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more information. + ## Setup ### Android @@ -48,7 +52,7 @@ This plugin now supports Swift package manager, and requires iOS 13+. * Open Runner.xcworkspace with Xcode and navigate to project settings then the tab _Signing & Capabilities._ * Select the Runner in targets in left sidebar then press the "+ Capability" in the left upper corner and choose _Near Field Communication Tag Reading._ -## Web +### Web The web version of this plugin **does not actually support NFC** in browsers, but uses a specific [WebUSB protocol](https://github.com/nfcim/flutter_nfc_kit/blob/master/WebUSB.md), so that Flutter programs can communicate with dual-interface (NFC / USB) devices in a platform-independent way. From d082a65c8513e88e8ea2a1076ca68200f7fb8ab9 Mon Sep 17 00:00:00 2001 From: Harry Chen Date: Sun, 29 Dec 2024 11:26:43 +0800 Subject: [PATCH 2/3] ci: limit run on push and PR to master / dev branches only Signed-off-by: Harry Chen --- .github/workflows/example-app.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/example-app.yml b/.github/workflows/example-app.yml index c464c24..f7faa45 100644 --- a/.github/workflows/example-app.yml +++ b/.github/workflows/example-app.yml @@ -1,6 +1,10 @@ name: Build Example App -on: [push, pull_request] +on: + push: + branches: [master, develop] + pull_request: + branches: [master, develop] jobs: build: From b4befb1c30127c8e8a747f5448fd7f485206eaf6 Mon Sep 17 00:00:00 2001 From: Fan DANG Date: Wed, 26 Feb 2025 20:14:13 +0800 Subject: [PATCH 3/3] bump to 3.6.0 --- CHANGELOG.md | 4 +--- example/pubspec.lock | 2 +- pubspec.yaml | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b8fb99..ac2127a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -177,9 +177,7 @@ * allow authentication of sector 0 (#157) * fix data type check in `writeBlock` (#161) -## 3.6.0-rc.6 - -This is a release candidate for 3.6.0. Please test it and report any issues. +## 3.6.0 * Requires Dart 3.6+ and Flutter 3.24+ * Remove annoying dependency on `js` library, replace with `dart:js_interop` diff --git a/example/pubspec.lock b/example/pubspec.lock index ae26e42..83e871a 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -92,7 +92,7 @@ packages: path: ".." relative: true source: path - version: "3.6.0-rc.6" + version: "3.6.0" flutter_test: dependency: "direct dev" description: flutter diff --git a/pubspec.yaml b/pubspec.yaml index 12e21f4..84eb15e 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: flutter_nfc_kit description: Provide NFC functionality on Android, iOS & Web, including reading metadata, read & write NDEF records, and transceive layer 3 & 4 data with NFC tags / cards -version: 3.6.0-rc.6 +version: 3.6.0 homepage: "https://github.com/nfcim/flutter_nfc_kit" environment: