From b085868ea07470c362b17010ed1d5cb6a5afdd96 Mon Sep 17 00:00:00 2001 From: Lucas Brunner <6707792+brunnelu@users.noreply.github.com> Date: Tue, 7 Nov 2023 19:28:38 +0000 Subject: [PATCH 1/3] added devcontainer config --- .devcontainer/contribute/.devcontainer.json | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .devcontainer/contribute/.devcontainer.json diff --git a/.devcontainer/contribute/.devcontainer.json b/.devcontainer/contribute/.devcontainer.json new file mode 100644 index 0000000000000..9b9c564a25449 --- /dev/null +++ b/.devcontainer/contribute/.devcontainer.json @@ -0,0 +1,15 @@ +{ + "image": "mcr.microsoft.com/devcontainers/universal:2", + "waitFor": "onCreateCommand", + "updateContentCommand": "python3 -m pip install pytest pytest-cov ruff mypy numpydoc black==23.3.0 pre-commit sphinx sphinx-gallery numpydoc matplotlib Pillow pandas scikit-image packaging seaborn sphinx-prompt sphinxext-opengraph sphinx-copybutton plotly pooch && pre-commit install", + "postCreateCommand": "", + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python" + ] + } + }, + "features": { + } + } From 8c9ee16c127fd225681d976bb99f7a687ec59233 Mon Sep 17 00:00:00 2001 From: Lucas Brunner <6707792+brunnelu@users.noreply.github.com> Date: Tue, 7 Nov 2023 19:30:06 +0000 Subject: [PATCH 2/3] added documentation --- .devcontainer/contribute/contribute.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .devcontainer/contribute/contribute.md diff --git a/.devcontainer/contribute/contribute.md b/.devcontainer/contribute/contribute.md new file mode 100644 index 0000000000000..c14e2f9243096 --- /dev/null +++ b/.devcontainer/contribute/contribute.md @@ -0,0 +1,17 @@ +# Cotribute Devcontainer + +## How to contribute + +If you are want to contribute code to this project, you can setup your your development environment as described in https://scikit-learn.org/dev/developers/contributing.html or use github devcontainer. + +This devcontainer automatically setup your development environment with all dependencies and tools. + +## How to use + +You can either use the devcontainer in VSCode or use it directly with github codespaces as described in the following: + +1. For sklean klick the fork button on the top right of the page. +2. Start a codespaces: click code -> open with codespaces and select the contributing devcontainer. +3. Best practice is to create a new branch for your changes. This way others can append/ change and improve a pull request. +4. Commit your changes and push them to your fork. You can use the source control on the left side of the screen. +5. Create a pull request to the main repository. From d20e037ddac3d50a82a76e036b1cb7d929fe9130 Mon Sep 17 00:00:00 2001 From: Lucas Brunner <6707792+brunnelu@users.noreply.github.com> Date: Tue, 7 Nov 2023 19:52:25 +0000 Subject: [PATCH 3/3] corrected spelling of devcontainer config for better readability --- .../contribute/{.devcontainer.json => devcontainer.json} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .devcontainer/contribute/{.devcontainer.json => devcontainer.json} (100%) diff --git a/.devcontainer/contribute/.devcontainer.json b/.devcontainer/contribute/devcontainer.json similarity index 100% rename from .devcontainer/contribute/.devcontainer.json rename to .devcontainer/contribute/devcontainer.json