diff options
| author | Jesse Duffield <jessedduffield@gmail.com> | 2022-11-13 12:05:14 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-13 12:05:14 +1100 |
| commit | 5eeaebde988c8e14a012bb8be280c1d40c590860 (patch) | |
| tree | 08269caee2f134cf7b6143c5e2d93709149d107a /CONTRIBUTING.md | |
| parent | e059641f3f8a564a96b310b86a9689fed20becc9 (diff) | |
Update CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 53b6f47b1..7534d04c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,26 @@ welcome your pull requests: If you've never written Go in your life, then join the club! Lazygit was the maintainer's first Go program, and most contributors have never used Go before. Go is widely considered an easy-to-learn language, so if you're looking for an open source project to gain dev experience, you've come to the right place. +## Running in a VSCode dev container + +If you want to spare yourself the hassle of setting up your dev environment yourself (i.e. installing Go, extensions, and extra tools), you can run the Lazygit code in a VSCode dev container like so: + + + +This requires that: +* you have docker installed +* you have the dev containers extension installed in VSCode + +See [here](https://code.visualstudio.com/docs/devcontainers/containers) for more info about dev containers. + +## Running in a Github Codespace + +If you want to start contributing to Lazygit with the click of a button, you can open the lazygit codebase in a Codespace: + + + +This allows you to contribute to Lazygit without needing to install anything on your local machine. The Codespace has all the necessary tools and extensions pre-installed. + ## Code of conduct Please note by participating in this project, you agree to abide by the [code of conduct]. @@ -192,6 +212,8 @@ Sometimes you will need to make a change in the gocui fork (https://github.com/j ./scripts/bump_lazycore.sh ``` +Or if you're using VSCode, there is a bump lazycore task you can find by going `cmd+shift+p` and typing 'Run task' + 5. Raise a PR in lazygit with those changes ## Improvements |