Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unit test GitHub actions + Sponsorship details #27

Merged
merged 2 commits into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github: BurkusCat
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
4 changes: 3 additions & 1 deletion .github/workflows/ci-demo-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,6 @@ jobs:
- name: Restore dependencies
run: dotnet restore samples\DemoApp\DemoApp.sln
- name: Build
run: dotnet build samples\DemoApp\DemoApp.sln -c Release
run: dotnet build samples\DemoApp\DemoApp.sln -c Release
- name: Run Unit Tests
run: dotnet test tests\DemoApp.UnitTests\DemoApp.UnitTests.csproj --verbosity normal
6 changes: 4 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build for CI
name: Build Library for CI

on:
push:
Expand All @@ -24,4 +24,6 @@ jobs:
- name: Restore dependencies
run: dotnet restore src\Burkus.Mvvm.Maui.sln
- name: Build
run: dotnet build src\Burkus.Mvvm.Maui.sln -c Release
run: dotnet build src\Burkus.Mvvm.Maui.sln -c Release
- name: Run Unit Tests
run: dotnet test tests\Burkus.Mvvm.Maui.UnitTests\Burkus.Mvvm.Maui.UnitTests.csproj --verbosity normal
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,21 @@

**⚠️ WARNING**: `Burkus.Mvvm.Maui` is currently an experimental library. The API will change frequently and there will be frequent backwards compatibility breaking changes. This library will be versioned as ["0.y.z"](https://semver.org/#spec-item-4) until a well-liked, stable API has been found. Only then would a version "1.y.z" and beyond be released.

# Supporting the Project 💖
<a href="https://github.com/sponsors/BurkusCat"><img align="right" src="art/mona.png" alt="Mona the GitHub Sponsor Octocat smiling and holding a heart"></a>

Hi there 👋 I'm Ronan Burke aka Burkus. I maintain this project during my spare time and I would love to be able to dedicate more time each month to supporting it! I would greatly appreciate if you would be able to [sponsor me on GitHub Sponsors](https://github.com/sponsors/BurkusCat). There are different rewards for each of the monthly or one-time sponsorship tiers such as:

- a sponsorship badge 🪙
- prioritized bug reports 🐛
- pair-programming sessions, consulting, or mentorship 🧑‍🏫
- shout-outs in this `README` 📢
- ... and more

<iframe src="https://github.com/sponsors/BurkusCat/card" title="Sponsor BurkusCat" height="225" width="600" style="border: 0;"></iframe>

<br clear="right"/>

# Documentation 📗
See the `DemoApp` in the `/samples` folder of this repository for a full example of this library in action. The [demo app](/samples/DemoApp/) has examples of different types of navigation, configuring the library, using lifecycle events, passing parameters, and showing native dialogs. The [test project](/tests/DemoApp.UnitTests/) for the demo app demonstrates how you can write tests with code that calls this library.

Expand Down Expand Up @@ -374,9 +389,7 @@ The below are some things of note that may help prevent issues from arising:
- [IPageVisibilityEvents](https://github.com/BurkusCat/Burkus.Mvvm.Maui/issues/7)
- [...and more](https://github.com/BurkusCat/Burkus.Mvvm.Maui/issues)

[Create an issue](https://github.com/BurkusCat/Burkus.Mvvm.Maui/issues/new/choose) to add your own suggestions.

![Green letters: M V V M laid out vertically](art/MvvmVertical.png)
[Create an issue](https://github.com/BurkusCat/Burkus.Mvvm.Maui/issues/new/choose) to add your own suggestions. Or, support the project and help influence its direction by [sponsoring me](https://github.com/sponsors/BurkusCat).

# Contributing 💁‍♀️
Contributions are very welcome! Please see the [contributing guide](CONTRIBUTING.MD) to get started.
Expand All @@ -386,4 +399,6 @@ Contributions are very welcome! Please see the [contributing guide](CONTRIBUTING
[![Build Demo App for CI](https://github.com/BurkusCat/Burkus.Mvvm.Maui/actions/workflows/ci-demo-app.yml/badge.svg)](https://github.com/BurkusCat/Burkus.Mvvm.Maui/actions/workflows/ci-demo-app.yml)

# License 🪪
The project is distributed under the [MIT license](LICENSE). Contributors do not need to sign a CLA.
The project is distributed under the [MIT license](LICENSE). Contributors do not need to sign a CLA.

![Green letters: M V V M laid out vertically](art/MvvmVertical.png)
Binary file added art/mona.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -211,13 +211,12 @@ public void ToQueryString_ForMultipleParameters_CreatesValidQueryString()
{ "param1", "value1" },
{ "param2", 123 },
{ "param3", true },
{ "param4", new DateTime(1994, 12, 12, 0, 0, 0, DateTimeKind.Utc) },
};

// Act
var result = navigationParameters.ToQueryString();

// Assert
Assert.Equal("?param1=value1&param2=123&param3=True&param4=12%2f12%2f1994+00%3a00%3a00", result);
Assert.Equal("?param1=value1&param2=123&param3=True", result);
}
}
Loading