Skip to content

Devcontainer configuration added #27743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions .devcontainer/contribute/contribute.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions .devcontainer/contribute/devcontainer.json
Original file line number Diff line number Diff line change
@@ -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": {
}
}