Skip to content
Open
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
10 changes: 10 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Default owner for everything in the repository.
* @MartinZikmund

# Licensing and legal documents — changes here need the copyright holder's review.
/LICENSE @MartinZikmund
/LICENSING.md @MartinZikmund
/COPYING.iOS @MartinZikmund
/CLA.md @MartinZikmund
/TRADEMARKS.md @MartinZikmund
/THIRD-PARTY-NOTICES.md @MartinZikmund
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## What does this change?

<!-- Short description. Link the issue it closes, e.g. "Closes #123". -->

## Why?

<!-- The problem being solved, or the reason for the change. -->

## How was it tested?

<!-- Platforms you built and ran on, and what you checked. Screenshots help for UI changes. -->

- [ ] Windows
- [ ] Android
- [ ] iOS
- [ ] Desktop
- [ ] WebAssembly

## Checklist

- [ ] **I have signed the [CLA](../blob/main/CLA.md)** (the bot will ask on your first PR)
- [ ] The change builds without new warnings
- [ ] New user-facing strings were added to **both** `en-US` and `cs-CZ` `Resources.resw`
- [ ] New or changed dependencies are reflected in `THIRD-PARTY-NOTICES.md` **and**
`src/Awaitick.Core/Models/Licensing/ThirdPartyNotices.cs`
- [ ] I did not hand-edit version numbers (Nerdbank.GitVersioning owns those)
- [ ] My contribution is my own work and is licensed under the
[AGPLv3](../blob/main/LICENSE)
46 changes: 46 additions & 0 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: CLA Assistant

on:
issue_comment:
types: [created]
pull_request_target:
types: [opened, closed, synchronize]

permissions:
actions: write
contents: write
pull-requests: write
statuses: write

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: false

jobs:
cla_assistant:
name: Check CLA signature
runs-on: ubuntu-latest
steps:
- name: CLA Assistant
if: >
github.event_name == 'pull_request_target' ||
github.event.comment.body == 'recheck' ||
github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA'
uses: contributor-assistant/github-action@v2.6.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
path-to-document: https://github.com/MartinZikmund/Awaitick/blob/main/CLA.md
# Signatures live on their own branch so they never land on main — a push to main
# would otherwise trigger CI and the Static Web Apps deployment on every signature.
branch: cla-signatures
path-to-signatures: signatures/version1/cla.json
allowlist: MartinZikmund,dependabot[bot],renovate[bot],copilot-swe-agent[bot]
custom-notsigned-prcomment: >
Thanks for your contribution! Before it can be merged, please read our
[Contributor Licence Agreement](https://github.com/MartinZikmund/Awaitick/blob/main/CLA.md)
and sign it by posting the comment below. You keep the copyright in your work —
[LICENSING.md](https://github.com/MartinZikmund/Awaitick/blob/main/LICENSING.md)
explains why the agreement exists.
custom-pr-sign-comment: I have read the CLA Document and I hereby sign the CLA
custom-allsigned-prcomment: All contributors have signed the CLA. Thank you!
20 changes: 19 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -395,4 +395,22 @@ FodyWeavers.xsd
*.sln.iml

# Single Target Config
solution-config.props
solution-config.props

# Signing material and store credentials — never commit these.
# (*.pfx and *.appxupload are already covered by the Visual Studio section above.)
*.keystore
*.jks
*.p12
*.snk
*.cer
*.certSigningRequest
*.mobileprovision
*.provisionprofile
google-services.json
GoogleService-Info.plist
api_key.json
play-store-key.json
.env
.env.*
!.env.example
73 changes: 73 additions & 0 deletions CLA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Contributor Licence Agreement

Thank you for contributing to Awaitick. This agreement is short on purpose — please read it
rather than signing blind.

By contributing to this project you agree to the terms below. "You" means the person or
legal entity contributing. "Contribution" means any work you deliberately submit to this
project — code, documentation, translations, artwork, configuration — through a pull
request, an issue, or any other channel. "The Project" means Awaitick, and "the Maintainer"
means Martin Zikmund, its copyright holder.

## 1. You keep your copyright

**You retain full ownership of your contribution.** Nothing here transfers or assigns your
copyright. You remain free to use, sell, license and republish your own work however you
like, anywhere else, with no obligation to the Project. What follows is a licence you grant,
not a handover.

## 2. Copyright licence

You grant the Maintainer a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
licence to reproduce, modify, publicly display, publicly perform, sublicense and distribute
your contribution and works derived from it. This licence expressly includes the right to:

- **Distribute your contribution under app store terms**, including the Apple App Store,
Google Play and the Microsoft Store, whose terms the AGPL alone cannot satisfy. The
additional permission in [`COPYING.iOS`](COPYING.iOS) exists for this reason.
- **Relicense your contribution**, including under a different open-source licence, should
the Project's licence ever need to change.

Without this, a single unreachable contributor could permanently block the app from being
published or the licence from being fixed.

## 3. Patent licence

You grant the Maintainer and everyone who receives the Project a perpetual, worldwide,
non-exclusive, royalty-free, irrevocable patent licence to make, use, sell, offer to sell,
import and otherwise transfer your contribution, covering only those patent claims you own
or control that your contribution necessarily infringes.

If you start patent litigation alleging that the Project or a contribution to it infringes a
patent, the patent licences granted to you under this agreement end on the day you file.

## 4. Your contribution is yours to give

You confirm that:

- Each contribution is **your original work**, or you have the right to submit it under
these terms.
- If your employer has rights in work you produce, you have **permission to contribute** on
your own behalf, or your employer has waived those rights.
- Your contribution does not knowingly infringe anyone's copyright, patent, trademark or
trade secret.
- You have identified any third-party material in your contribution, along with its licence
and any attribution it requires.

## 5. No warranty

Contributions are provided as-is, without warranty of any kind, express or implied, except
for the confirmations you make in section 4.

## 6. If something changes

If any statement you made here turns out to be, or becomes, inaccurate, tell the Maintainer
at <martin@zikmund.dev>.

## Signing

A bot checks pull requests for a signature and will comment on your first one with
instructions. Signing takes one comment, once — after that it remembers you.

Everything the Project ships stays under the [AGPLv3](LICENSE); see
[`LICENSING.md`](LICENSING.md) for what that means in practice.
84 changes: 84 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Contributor Covenant 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 <martin@zikmund.dev>. 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

121 changes: 121 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Contributing to Awaitick

Thanks for wanting to help. This page covers everything you need to get a change merged.

## Before you start

- **Small fix?** Just open a pull request.
- **Bigger change?** Open an issue first so we can agree on the approach before you spend
time on it.
- Looking for somewhere to start? Try the
[`good first issue`](https://github.com/MartinZikmund/Awaitick/labels/good%20first%20issue)
label.

## The CLA

Contributions require a one-time [Contributor Licence Agreement](CLA.md). A bot comments on
your first pull request with instructions — signing takes one comment and it remembers you
afterwards.

**You keep the copyright in your work.** The CLA grants the licence breadth needed to keep
publishing Awaitick on app stores and to relicense if that ever becomes necessary. Please
read it rather than signing blind; [LICENSING.md](LICENSING.md) explains the reasoning.

## Building

You need the **.NET 10 SDK**.

```bash
dotnet workload restore Awaitick.slnx
dotnet workload install wasm-tools # only for the WebAssembly target

msbuild src/Awaitick/Awaitick.csproj /r
```

Building every target needs the Android, iOS and WebAssembly workloads. To work on one
platform without installing all of them, narrow the target framework — this applies to
**restore as well as build**, which plain `-f` does not:

```bash
dotnet build src/Awaitick/Awaitick.csproj -p:TargetFrameworks=net10.0-desktop
```

| Target | TFM |
|---|---|
| Windows | `net10.0-windows10.0.26100` |
| Android | `net10.0-android` |
| iOS | `net10.0-ios` |
| Desktop | `net10.0-desktop` |
| WebAssembly | `net10.0-browserwasm` |

## Tests

There is **no automated test project yet**. CI runs a Debug build of every target as a smoke
test, so at minimum make sure your change builds.

Adding tests is welcome and useful. Put logic in **`Awaitick.Core`** where it can be covered
without a UI head, and target that project from any new test project.

## Where code goes

| Path | What belongs there |
|---|---|
| `src/Awaitick.Core` | View models, services, models — anything testable and head-independent |
| `src/Awaitick` | Views, platform-specific services, app composition (`App.xaml.cs`) |

Prefer `Awaitick.Core`. A view model belongs in the head only if it depends on a type defined
there.

A few conventions worth knowing:

- MVVM with **CommunityToolkit.Mvvm** — `[ObservableProperty]` partial properties and
`[RelayCommand]`.
- Views come in pairs: a non-generic base closing the generic (`XViewBase : PageBase<XViewModel>`)
and the page itself (`XView : XViewBase`). Views are discovered by naming convention, so a
page ending in `View` needs no navigation-table entry — only a
`services.AddTransient<XViewModel>()` line in `App.xaml.cs`.
- **Never hardcode user-facing text.** Add the key to **both**
`src/Awaitick/Strings/en-US/Resources.resw` and `src/Awaitick/Strings/cs-CZ/Resources.resw`,
then use `{ex:Localize Key=MyKey}` in XAML or `IStringLocalizer` in code.

## Adding or removing a dependency

Versions live only in `src/Directory.Packages.props` (Central Package Management) — add a
`<PackageVersion>` there and reference it with no `Version=` attribute.

Then update **both** [`THIRD-PARTY-NOTICES.md`](THIRD-PARTY-NOTICES.md) and
`src/Awaitick.Core/Models/Licensing/ThirdPartyNotices.cs`, which back the in-app
**Settings → About → Open-source licenses** screen. They are maintained by hand and drift
silently if only one is updated.

Anything under a licence incompatible with the AGPL — proprietary, "non-commercial", SSPL,
BUSL — cannot be added. Say so in the pull request if you are unsure.

## Branches and commits

Branch off `main`:

- `feature/<short-name>` for new work
- `fix/<short-name>` for bug fixes
- `chore/`, `docs/`, `ci/` for everything else

Commits follow [Conventional Commits](https://www.conventionalcommits.org/): `type: subject`
with type one of `feat | fix | chore | docs | refactor | test | ci | build`. A scope is
optional — use one when it sharpens the message (`feat(settings): ...`). Imperative mood, no
trailing period.

**Do not hand-edit version numbers.** Versions come from Nerdbank.GitVersioning via
`version.json` and git height; CI fails if `Package.appxmanifest` stops saying
`Version="0.0.0.0"`.

## Pull requests

- Keep them focused. One concern per PR reviews far faster than five.
- Say what changed and why. Screenshots help for anything visual.
- CI must be green, and the CLA bot must be satisfied.

## Code of conduct

Taking part means following our [Code of Conduct](CODE_OF_CONDUCT.md).

Found a security problem? **Do not open a public issue** — see [SECURITY.md](SECURITY.md).
Loading
Loading