Skip to content

Latest commit

 

History

History
132 lines (110 loc) · 7.84 KB

CONTRIBUTING.md

File metadata and controls

132 lines (110 loc) · 7.84 KB
Raw

How to Contribute:

You can contribute to DevToys app by:

  • Report issues and bugs here.
  • Submit feature requests here.
  • Creating a pull request.
  • Internationalization and localization:
    • See instructions here.

How to Build and Run DevToys and DevToys CLI (without tools) from source:

From Windows

Prerequisites

  1. Make sure your machine is running on Windows 10 1903 (19h1) or later.
  2. Install Visual Studio 2022 17.3 or later installed with the following Workloads, or import the vs2022.vsconfig file.
    • ASP.NET and web development
    • Node.js development
    • .NET desktop development
  3. Install latest Node.js.

Finalize your environment

  1. Clone this repository.
  2. Open a PowerShell command prompt in the root folder of this repository.
  3. Install Nuke.Build command line tooling with the following command from the command prompt: 
    dotnet tool install Nuke.GlobalTool --global
  4. Restore all the dependencies with the following command: 
    .\init.ps1

Build, Run & Debug

  1. Open src/DevToys-Windows.sln with Visual Studio.
  2. In Visual Studio, set app/dev/platforms/desktop/DevToys.Windows or app/dev/platforms/desktop/DevToys.CLI as startup project.
  3. Now you should be able to build and run DevToys on your machine by pressing F5.
  4. Most of the DevToys.Windows app runs in a web browser (WebView2). Press F12 to open the web developer tools.

From macOS

Prerequisites

  1. Make sure your machine is running on macOS 12.0 or later.
  2. Install Xcode 15.0 or later. Run it at least once and allow it to install the built-in macOS and iOS tooling.
  3. Visual Studio Code with C# Dev Kit, or JetBrains Rider.

    Visual Studio for Mac is not supported because it is a deprecated product and does not support .NET 8.0.

  4. .NET SDK. This is required to build the app itself.

    Use dotnet --version from the terminal to get the version installed.

  5. Node.js 14.0 or later. This is required to build Monaco Editor.
  6. If you're using an Mac computer with Apple silicon processor, install Rosetta 2 using the following command in a Terminal: 
    softwareupdate --install-rosetta

Finalize your environment

  1. Clone this repository.
  2. Open a Terminal
  3. Install Nuke.Build command line tooling with the following command from the command prompt: 
    dotnet tool install Nuke.GlobalTool --global
  4. Restore all the dependencies with the following command: 
    sh init.sh

Build, Run & Debug

If you are using JetBrains Rider:

  1. Open src/DevToys-MacOS.sln with JetBrains Rider.
  2. Set app/dev/platforms/desktop/DevToys.MacOS or app/dev/platforms/desktop/DevToys.CLI as startup project.
  3. Now you should be able to build and run DevToys on your machine.

If you are using Visual Studio Code:

  1. Open the repository in Visual Studio Code to edit the code.
  2. In Run and Debug, select DevToys MacOS or DevToys CLI and press Start.

Special note for DevToys.MacOS

Most of the DevToys.MacOS app runs in a web browser (Safari). In order to access the Safari developer tools with macOS to debug the HTML/CSS/JS of the Blazor app, you might need to follow the following instructions:

  1. Open desktop Safari.
  2. Select the Safari > Preferences > Advanced > Show features for web developers in the menu bar checkbox.
  3. Run the DevToys.MacOS app in macOS.
  4. Return to Safari. On the main menu, select Develop > {REMOTE INSPECTION TARGET} > 0.0.0.0, where the {REMOTE INSPECTION TARGET} placeholder is either the devices's plain name (for example, MacBook Pro) or the device's serial number (for example XMVM7VFF10). If multiple entries for 0.0.0.0 are present, select the entry that highlights the BlazorWebView. The BlazorWebView is highlighted in blue in macOS when the correct 0.0.0.0 entry is selected.
  5. The Web Inspector window appears for the BlazorWebView.

From Linux

Prerequisites

  1. Make sure your machine has GTK4 and WebKitGTK installed. Distro like Ubuntu generally have it pre-installed.
  2. Visual Studio Code with C# Dev Kit, or JetBrains Rider.
  3. .NET SDK. This is required to build the app itself.
    • .NET 8.0 SDK (version 8.0 (SDK 8.0.100) or later).
    • Unless GTK has been installed through snap, we recommend to avoid installing .NET from snap.
    • We recommend installing .NET from the official script, then the dependencies, and finally set the environment variables.

    • Use dotnet --version from the terminal to get the version installed.

  4. Node.js 14.0 or later. This is required to build Monaco Editor.

Finalize your environment

  1. Clone this repository.
  2. Open a Terminal command prompt in the root folder of this repository.
  3. Install Nuke.Build command line tooling with the following command from the command prompt: 
    dotnet tool install Nuke.GlobalTool --global
  4. Restore all the dependencies with the following command: 
    bash init.sh

Build, Run & Debug

If you are using JetBrains Rider:

  1. Open src/DevToys-Linux.sln with JetBrains Rider.
  2. Set app/dev/platforms/desktop/DevToys.Linux or app/dev/platforms/desktop/DevToys.CLI as startup project.
  3. Now you should be able to build and run DevToys on your machine.

If you are using Visual Studio Code:

  1. Open the repository in Visual Studio Code to edit the code.
  2. In Run and Debug, select DevToys Linux or DevToys CLI and press Start.

How to Build and Run DevToys and DevToys CLI with default tools from source:

See DevToys.Tools's CONTRIBUTING.md file.

Internationalization and localization

Please use Crowdin to translate DevToys and its tools. Crowdin is a localization management platform that helps individuals to translate a project without having to be familiar with its repository.

  • Go on DevToy's Crowdin project.
  • Log in or create an account. Join the DevToys project.
  • Select the language of your choice in the list of existing supported language and let yourself guided by the website to translate the app.
  • If you want to add a new language, please create a new discussion on Crowdin's website or on GitHub. We will be happy to add your language to the list.
  • When your translation is done, it will be synchronized with our GitHub repository within 1 hour and create a pull request.