Skip to content

Document How to Set Up a Development Environment with Docker #597

Closed

Description

@rmorshea

Current Situation

Presently for contributors working on Windows, the test suite does not run successfully. As a result it's hard for developers on Windows to contribute features and fixes. While there may be ways to mitigate this in the future, we should take steps now to ensure a consistent contributor experience regardless of your chosen OS.

Proposed Actions

The easiest way to level the playing field here is to write up documentation and create tools which would allow someone to spin up a development environment inside a docker container.

Work Items

  • Make Dockerfile which can spin up a dev env
  • Write docs on how to use dev env container

Activity

  1. added
    priority-3-lowMay be resolved one any timeline.
    type-docsAbout changes and updates to documentation
    and removed on Jan 19, 2022
  2. added this to the milestone on Feb 16, 2022
  3. rmorshea commented on Feb 16, 2022

    @rmorshea
    CollaboratorAuthor

    I think this may be related to: #657

  4. Archmonger commented on Apr 15, 2022

    @Archmonger
    Contributor

    The best way of doing this would be using vscode configuration, which would automate the docker setup. Only thing users would need to do is install docker.

    On Windows, that also involves enabling Windows Subsystem for Linux (WSL).

  5. removed this from the milestone on Jan 29, 2023
  6. Archmonger commented on Jan 25, 2025

    @Archmonger
    Contributor

    Closing as it's unnecessary tooling to maintain. Our tool chain now works cross-platform (win/linux/mac).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    flag-good-first-issueA well defined and self-contained task.priority-3-lowMay be resolved one any timeline.type-docsAbout changes and updates to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      ⌂ Proxy