Skip to content

Commit cd219ca

Browse files
Update CONTRIBUTING.md reference for Codespaces
Signed-off-by: Samruddhi Khandale <[email protected]>
1 parent 043525c commit cd219ca

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,15 @@ GO_BUILD_FLAGS="-buildmode=pie" make build
7575

7676
This is a more recently added environmnent that aims to make it faster for new contributors to get started with etcd. This option is supported for etcd versions 3.6 onwards.
7777

78-
This option can be [used locally](https://code.visualstudio.com/docs/devcontainers/tutorial) on a system running Visual Studio Code and Docker, or in a remote cloud based [Codespaces](https://github.com/features/codespaces) environment. The instructions below are based on the Codespaces option as this can be setup and running in just a few clicks.
78+
This option can be [used locally](https://code.visualstudio.com/docs/devcontainers/tutorial) on a system running Visual Studio Code and Docker, or in a remote cloud based [Codespaces](https://github.com/features/codespaces) environment.
7979

80-
Follow the steps below to setup the environment:
80+
To get started, create a codespace for this repository by clicking this 👇
81+
82+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=11225014)
83+
84+
A codespace will open in a web-based version of Visual Studio Code. The [dev container](.devcontainer/devcontainer.json) is fully configured with software needed for this project.
8185

82-
- [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
83-
- Click the green `<> Code` button and click the `Codespaces` tab.
84-
- Click the `+` button to create a codespace, this will automatically install the required build tools for developing etcd.
86+
**Note**: Dev containers is an open spec which is supported by [GitHub Codespaces](https://github.com/codespaces) and [other tools](https://containers.dev/supporting).
8587

8688
[file an issue]: https://github.com/etcd-io/etcd/issues/new/choose
8789

0 commit comments

Comments
 (0)