WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
ac05ded
Move PR comment creation to separate workflow on:pull_request_target
softworkz Nov 17, 2025
54eac4b
Add workflow files to solution
softworkz Nov 17, 2025
91ed116
Harden reading of PR number against injection attacks
softworkz Nov 17, 2025
bfad0cd
Merge pull request #937 from softworkz/submit_move_workflow
FlorianRappl Nov 17, 2025
8ff8754
Fix API break: public API must not expose JsonElement objects
softworkz Nov 17, 2025
b89c08e
IpcMainTests: Properly test for the types of values (must not be Json…
softworkz Nov 17, 2025
5f6e4a9
Disable Nullable for all projects (was already for API/AspNet)
softworkz Nov 17, 2025
9e9558b
SocketIoFacade: Remove unused method
softworkz Nov 17, 2025
be518a7
IpcMain: Properly handle Ipc message params (always 2-elem array)
softworkz Nov 17, 2025
2e5c620
ShowItemInFolderAsync: Fix endless hang
softworkz Nov 17, 2025
55c0353
Use non-generic TaskCompletionSource where applicable
softworkz Nov 17, 2025
edafa8c
Merge pull request #939 from softworkz/submit_cleanup
FlorianRappl Nov 17, 2025
ef41329
Merge pull request #938 from softworkz/submit_ipc_types
FlorianRappl Nov 17, 2025
d05191d
electron-builder: Provide correct output path and fix publish url
softworkz Nov 18, 2025
9b4e0e4
Merge pull request #942 from softworkz/submit_outpath
FlorianRappl Nov 19, 2025
aa483eb
Updated version
FlorianRappl Nov 19, 2025
1815951
BrowserWindowOptions; Fix default for FullScreenable
softworkz Nov 20, 2025
2f4d37d
Try macOS 26
softworkz Nov 20, 2025
1d554fd
Merge pull request #945 from softworkz/submit_outpath
FlorianRappl Nov 20, 2025
41d9f0a
Integration CI Tests: Extend matrix for more runners and two Electron…
softworkz Nov 20, 2025
6761119
Update all model classes to Electron API 39.2
softworkz Nov 22, 2025
77834d0
Drop workaround via DescriptinoAttribute: No longer needed
softworkz Nov 21, 2025
59887cc
Guard deserialization error
softworkz Nov 21, 2025
3821ca6
getPrinters: Increase timeout
softworkz Nov 22, 2025
4de7760
Merge pull request #948 from softworkz/submit_extend_test_matrix
FlorianRappl Nov 22, 2025
c92a54f
Merge pull request #949 from softworkz/submit_model_update
FlorianRappl Nov 22, 2025
0acdc65
adding macOS Intel runner
agracio Nov 24, 2025
20212cd
Merge pull request #951 from agracio/macos-intel-runners
FlorianRappl Nov 24, 2025
276ce8f
README.md: fix grammar and typos
kevinfoley Nov 26, 2025
c81ed54
Merge pull request #953 from kevinfoley/readme-fix
FlorianRappl Nov 29, 2025
dae5211
adding WebContents APIs for Zoom, Audio and DevTools
agracio Dec 4, 2025
e09ef35
removing incorrect import
agracio Dec 4, 2025
90f5f5d
attempting to fix some tests on CI
agracio Dec 4, 2025
7eaf84a
attempting to fix some tests on CI
agracio Dec 4, 2025
ce8a86b
trying to fix some tests on CI
agracio Dec 4, 2025
65db66b
trying a different env variable for skipping tests
agracio Dec 4, 2025
c0e3a59
adding a couple `await Task.Delay(500);` to test in order to resolve …
agracio Dec 4, 2025
46d395a
excluding some tests based on GitHub runner OS
agracio Dec 4, 2025
e52bf69
excluding some tests based on GitHub runner OS
agracio Dec 4, 2025
7c39d28
adding missing semicolon
agracio Dec 5, 2025
f1063bb
Merge pull request #958 from agracio/apis
FlorianRappl Dec 5, 2025
4ee11aa
removing properties
agracio Dec 6, 2025
cf185fd
removing properties from webContents.ts
agracio Dec 6, 2025
8ccc7bf
updating Microsoft.VisualStudio.JavaScript.Sdk to correct version
agracio Dec 6, 2025
44a820e
Merge pull request #960 from agracio/apis
FlorianRappl Dec 6, 2025
7c8eeef
GetPrintersAsync: Increase timeout
softworkz Dec 6, 2025
347c1ef
Show_hide_visibility_roundtrip: Don't use shared window
softworkz Dec 6, 2025
6246b44
ReadyToShow_event_fires: Destroy window
softworkz Dec 6, 2025
daa9f39
ScreenTests: Remove invalid constraints
softworkz Dec 6, 2025
c90f003
GetSetZoomLevel: Don't use shared window
softworkz Dec 6, 2025
88d2daa
WebContentsTests: Experiment!
softworkz Dec 6, 2025
9bb2adc
Use 3s timeout for GetUserAgentAsync and updat test
softworkz Dec 6, 2025
2b2b26e
GetSetUserAgent
softworkz Dec 6, 2025
c97f914
Introduce TimeSpan extensions
softworkz Dec 7, 2025
153625b
Introduce IntegrationFactAttribute
softworkz Dec 7, 2025
95e02e2
Introduce common base class for tests
softworkz Dec 7, 2025
f548ff0
Add migration checks
softworkz Dec 7, 2025
0321804
Add documentation for migration checks
softworkz Dec 7, 2025
d0eb088
Fix publishing documentation
softworkz Dec 7, 2025
2c82206
Merge pull request #966 from softworkz/submit_migrationchecks
FlorianRappl Dec 7, 2025
1ac371b
Merge pull request #962 from softworkz/submit_testupd
FlorianRappl Dec 9, 2025
0a54735
Merge branch 'main' of https://github.com/ElectronNET/Electron.NET in…
FlorianRappl Dec 10, 2025
70ffebf
Updated changelog
FlorianRappl Dec 10, 2025
5f76804
Fix buidl by adding necessary using directives for async and DI setup.
davidroth Dec 10, 2025
1baa5c6
Drop .NET 6.0, default to .NET 10.0 and update dependencies
davidroth Dec 10, 2025
81b3793
Merge pull request #974 from davidroth/dotnet-targets
FlorianRappl Dec 11, 2025
7f507a6
Merge pull request #975 from davidroth/missing-usings
FlorianRappl Dec 11, 2025
218b998
Add dynamic tray menu update functionality
davidroth Dec 10, 2025
0d732ce
Partially revert "Drop .NET 6.0, default to .NET 10.0 and update depe…
softworkz Dec 11, 2025
b3f5a3c
Merge pull request #976 from softworkz/submit_revertnet6
FlorianRappl Dec 11, 2025
49eaa5e
Merge pull request #973 from davidroth/set-menu-items
FlorianRappl Dec 11, 2025
e070759
integration-tests: Add random delay
softworkz Dec 11, 2025
f1b4766
Add automatic retry for failed test jobs
softworkz Dec 11, 2025
33da428
Fix build after PR merge
softworkz Dec 12, 2025
5a7cbd9
Combine and separate workflows
softworkz Dec 12, 2025
70e8f85
Merge pull request #977 from softworkz/submit_revertnet6
FlorianRappl Dec 12, 2025
8d4cddd
Conditionally set AutoHideMenuBar for Windows/Linux
markatosi Dec 12, 2025
c53a5a9
Merge pull request #982 from markatosi/develop
FlorianRappl Dec 13, 2025
f32a40f
Add macOS profiles for ASP.NET and Console apps
markatosi Dec 13, 2025
515d325
Fixed startup in VS Code
FlorianRappl Dec 13, 2025
f148fe6
Merge pull request #983 from markatosi/develop
FlorianRappl Dec 13, 2025
b326f86
Updated changelog
FlorianRappl Dec 13, 2025
321b8cd
Merge branch 'develop' of https://github.com/ElectronNET/Electron.NET…
FlorianRappl Dec 13, 2025
8ed7f27
Make sure the electron-host-hook strays unobtrusive
FlorianRappl Dec 13, 2025
0b45317
Added contributing guide
FlorianRappl Dec 14, 2025
19e785f
Fixed whitespace
FlorianRappl Dec 14, 2025
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
137 changes: 137 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
# Contributing

## Project Scope

The Electron.NET project ultimately tries to provide a framework for developing cross-platform client applications on the basis of .NET and Electron. Anything that is related to this goal will be considered. The project aims to be as close to Electron with .NET as a basis as possible. If your contribution does not reflect that goal, the chances of accepting it are limited.

## Code License

This is an open source project falling under the [MIT License](../LICENSE). By using, distributing, or contributing to this project, you accept and agree that all code within the Electron.NET project and its libraries are licensed under MIT license.

## Becoming a Contributor

Usually appointing someone as a contributor follows this process:

1. An individual contributes actively via discussions (reporting bugs, giving feedback to existing or opening new issues) and / or pull requests
2. The individual is either directly asked, invited or asks for contributor rights on the project
3. The individual uses the contribution rights to sustain or increase the active contributions

Every contributor might have to sign the contributor's license agreement (CLA) to establish a legal trust between the project and its contributors.

## Working on Electron.NET

### Issue Discussion

Discussion of issues should be placed transparently in the issue tracker here on GitHub.

* [General issues, bugs, new features](https://github.com/ElectronNET/Electron.NET/issues)
* [General discussions, help, exchange of ideas](https://github.com/ElectronNET/Electron.NET/discussions)

### Modifying the code

Electron.NET and its libraries uses features from the latest versions of C# (e.g., C# 10). You will therefore need a C# compiler that is up for the job.

1. Fork and clone the repo.
2. First try to build the ElectronNET.Core library and see if you get the tests running.
3. You will be required to resolve some dependencies via NuGet.

The build system of Electron.NET uses NUKE.

### Code Conventions

Most parts in the Electron.NET project are fairly straight forward. Among these are:

* Always use statement blocks for control statements, e.g., in a for-loop, if-condition, ...
* You may use a simple (throw) statement in case of enforcing contracts on argument
* Be explicit about modifiers (some files follow an older convention of the code base, but we settled on the explicit style)

### Development Workflow

1. If no issue already exists for the work you'll be doing, create one to document the problem(s) being solved and self-assign.
2. Otherwise please let us know that you are working on the problem. Regular status updates (e.g. "still in progress", "no time anymore", "practically done", "pull request issued") are highly welcome.
3. Create a new branch—please don't work in the `main` branch directly. It is reserved for releases. We recommend naming the branch to match the issue being addressed (`feature/#777` or `issue-777`).
4. Add failing tests for the change you want to make. Tests are crucial and should be taken from W3C (or other specification).
5. Fix stuff. Always go from edge case to edge case.
6. All tests should pass now. Also your new implementation should not break existing tests.
7. Update the documentation to reflect any changes. (or document such changes in the original issue)
8. Push to your fork or push your issue-specific branch to the main repository, then submit a pull request against `develop`.

Just to illustrate the git workflow for Electron.NET a little bit more we've added the following graphs.

Initially, Electron.NET starts at the `main` branch. This branch should contain the latest stable (or released) version.

Here we now created a new branch called `develop`. This is the development branch.

Now active work is supposed to be done. Therefore a new branch should be created. Let's create one:

```sh
git checkout -b feature/#777
```

There may be many of these feature branches. Most of them are also pushed to the server for discussion or synchronization.

```sh
git push -u origin feature/#777
```

Now feature branches may be closed when they are done. Here we simply merge with the feature branch(es). For instance the following command takes the `feature/#777` branch from the server and merges it with the `develop` branch.

```sh
git checkout develop
git pull
git pull origin feature/#777
git push
```

Finally, we may have all the features that are needed to release a new version of Electron.NET. Here we tag the release. For instance for the 1.0 release we use `v1.0`.

```sh
git checkout main
git merge develop
git tag v1.0
```

(The last part is automatically performed by our CI system. Don't tag manually.)

### Versioning

The rules of [semver](http://semver.org/) don't necessarily apply here, but we will try to stay quite close to them.

Prior to version 1.0.0 we use the following scheme:

1. MINOR versions for reaching a feature milestone potentially combined with dramatic API changes
2. PATCH versions for refinements (e.g. performance improvements, bug fixes)

After releasing version 1.0.0 the scheme changes to become:

1. MAJOR versions at maintainers' discretion following significant changes to the codebase (e.g., API changes)
2. MINOR versions for backwards-compatible enhancements (e.g., performance improvements)
3. PATCH versions for backwards-compatible bug fixes (e.g., spec compliance bugs, support issues)

#### Code style

Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.** In general most of the [C# coding guidelines from Microsoft](https://msdn.microsoft.com/en-us/library/ff926074.aspx) are followed. This project prefers type inference with `var` to explicitly stating (redundant) information.

It is also important to keep a certain `async`-flow and to always use `ConfigureAwait(false)` in conjunction with an `await` expression.

## Backwards Compatibility

We always try to remain backwards compatible beyond the currently supported versions of .NET.

For instance, in December 2025 there have been activity to remove .NET 6 support from the codebase. We rejected this. Key points:

1. We have absolutely no need to drop `.net6` support. It doesn't hurt us in any way.
2. Many are still using `.net6`, including Electron.NET (non-Core) users. It doesn't make sense to force them to update two things at the same time (.NET + Electron.NET).
3. We MUST NOT and NEVER update `Microsoft.Build.Utilities.Core`. This will make Electron.NET stop working on older Visual Studio and MSBuild versions. There's are also no reasons to update it in the first place.

It's important to note that the Microsoft label of "Out of support" on .NET has almost no practical meaning. We've rarely (if ever) seen any bugs fixed in the same .NET version which mattered. The bugs that all new .NET versions have are much worse than mature .NET versions which are declared as "out of support". Keep in mind that the LTS matters most for active development / ongoing supported projects. If, e.g., a TV has been released a decade ago it most likely won't be patched. Still, you might want to deploy applications to it, which then naturally would involve being based on "out of support" versions of the framework.

TL;DR: Unless there is a technical reason (e.g., a crucial new API not being available) we should not drop "out of support" .NET versions. At the time of writing (December 2025) the minimum supported .NET version remains at `.net6`.

## Timeline

**All of this information is related to ElectronNET.Core pre-v1!**

We pretty much release whenever we have something new (i.e., do fixes such as a 0.1.1, or add new features, such as a 0.2.0) quite quickly.

We will go for a 1.0.0 release of this as early as ~mid of January 2026 (unless we find some critical things or want to extend the beta phase for ElectronNET.Core). This should be sufficient time to get some user input and have enough experience to call it stable.
Original file line number Diff line number Diff line change
@@ -1,33 +1,25 @@
name: CI
name: Build and Publish

on: [push, pull_request]
on: [push]

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}

jobs:
# linux:
# runs-on: ubuntu-latest
# timeout-minutes: 10

# steps:
# - uses: actions/checkout@v4
concurrency:
group: build-publish-${{ github.ref }}
cancel-in-progress: true

# - name: Setup dotnet
# uses: actions/setup-dotnet@v4
# with:
# dotnet-version: |
# 6.0.x
# 8.0.x
# 10.0.x

# - name: Build
# run: ./build.sh
jobs:
Integration-Tests:
uses: ./.github/workflows/integration-tests.yml
name: '1'

windows:
Publish:
needs: [Integration-Tests]
runs-on: windows-latest
timeout-minutes: 10
name: '2 / Publish'

steps:
- uses: actions/checkout@v4
Expand Down
39 changes: 39 additions & 0 deletions .github/workflows/PR Validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: PR Validation

on: [pull_request]

concurrency:
group: pr-validation-${{ github.ref }}
cancel-in-progress: true

jobs:
Whitespace-Check:
uses: ./.github/workflows/trailing-whitespace-check.yml
secrets: inherit
name: '1'

Tests:
needs: Whitespace-Check
uses: ./.github/workflows/integration-tests.yml
secrets: inherit
name: '2'

build:
needs: [Whitespace-Check, Tests]
runs-on: windows-latest
timeout-minutes: 10
name: '3 / Build'

steps:
- uses: actions/checkout@v4

- name: Setup dotnet
uses: actions/setup-dotnet@v4
with:
dotnet-version: |
6.0.x
8.0.x
10.0.x

- name: Build
run: .\build.ps1
Loading