File tree Expand file tree Collapse file tree 1 file changed +42
-1
lines changed Expand file tree Collapse file tree 1 file changed +42
-1
lines changed Original file line number Diff line number Diff line change 1
- https://code.visualstudio.com/docs/devcontainers/tutorial
1
+ # Development Container
2
+
3
+ This is ** Devcontainer** configuration to provide a consistent development environment for all contributors.
4
+
5
+ ## Features
6
+
7
+ - [x] Pre-configured ** Python environment**
8
+ - [x] Automatic installation of ** pre-commit hooks**
9
+ - [x] ** Ruff** linter ready to check your code
10
+ - [x] ** Oh My Zsh** with plugins:
11
+ - ` zsh-autosuggestions `
12
+ - ` zsh-syntax-highlighting `
13
+
14
+ ## Usage
15
+
16
+ 1 . Install [ ** Docker** ] ( https://www.docker.com/get-started/ ) and [ ** Visual Studio Code** ] ( https://code.visualstudio.com/ )
17
+ 2 . Install the ** Remote - Containers** extension in VS Code
18
+
19
+ - Do ` CTRL+P ` , paste this command and press ` Enter `
20
+
21
+ ``` shell
22
+ ext install ms-vscode-remote.remote-containers
23
+ ```
24
+ 3. Open this repository in VS Code
25
+ 4. When prompted, click ** " Reopen in Container" **
26
+ 5. Wait for the environment to build and initialize
27
+
28
+ After setup:
29
+
30
+ - ` pre-commit` hooks are installed
31
+ - ` ruff` and other tools are available
32
+ - The shell uses Zsh by default
33
+
34
+ # # Tips
35
+
36
+ To manually run checks on all files:
37
+
38
+ ` ` ` bash
39
+ pre-commit run --all-files
40
+ ` ` `
41
+
42
+ > For further information here' s [Microsoft tutorial about devcontainers.](https://code.visualstudio.com/docs/devcontainers/tutorial)
You can’t perform that action at this time.
0 commit comments