Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (46 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 2.23 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, or any other method with me or the maintainers of this repository before making a change.

This project has a Code of Conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Do not include the build itself where the project is cleaned using dotnet clean.
  2. Update the README.md with details of changes to the project, new features, and others if applicable.
  3. Increase the version number of the project and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

Build

If you just want to run the program, there are precompiled releases that can be found in here.

Requirements

Publish a single binary for Windows

git clone https://github.com/Jed556/AutoMidiPlayer.git
cd AutoMidiPlayer

dotnet publish -r win-x86 -c Release -o bin\publish --self-contained false -p:PublishSingleFile=true

For other runtimes, visit the RID Catalog and change the runtime value.

Build the project (not necessary if you published)

git clone https://github.com/Jed556/AutoMidiPlayer.git
cd AutoMidiPlayer

dotnet build

Publish the project using defaults

git clone https://github.com/Jed556/AutoMidiPlayer.git
cd AutoMidiPlayer

dotnet publish

Notes

If you want to build using the .Net Core 3.1 SDK, you need to make a few changes to the project files.

Project SDK

Change the Project SDK of AutoMidiPlayer.WPF.csproj into Microsoft.NET.Sdk.WindowsDesktop.

- <Project Sdk="Microsoft.NET.Sdk">
+ <Project Sdk="Microsoft.NET.Sdk.WindowsDesktop">

Language Version

Change the LangVersion of both projects into preview.

- <LangVersion>latest</LangVersion>
+ <LangVersion>preview</LangVersion>