Skip to content

docs(contrib): update linux requirements #4328

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

Merged
merged 1 commit into from
Nov 1, 2021
Merged

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Oct 8, 2021

This PR updates the CONTRIBUTING.md, specifically adding a section for Linux-related dependencies needed to develop code-server.

H/T to @bryphe-coder and @vapurrmaid for testing this out on Ubuntu-based dev environments and helping us improve the docs!

Fixes N/A

@jsjoeio jsjoeio added the docs Documentation related label Oct 8, 2021
@jsjoeio jsjoeio self-assigned this Oct 8, 2021
@jsjoeio jsjoeio requested a review from a team as a code owner October 8, 2021 17:58
@codecov
Copy link

codecov bot commented Oct 8, 2021

Codecov Report

Merging #4328 (5b49136) into main (976891a) will not change coverage.
The diff coverage is n/a.

❗ Current head 5b49136 differs from pull request most recent head 66a2a16. Consider uploading reports for the commit 66a2a16 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4328   +/-   ##
=======================================
  Coverage   66.29%   66.29%           
=======================================
  Files          31       31           
  Lines        1620     1620           
  Branches      316      316           
=======================================
  Hits         1074     1074           
  Misses        468      468           
  Partials       78       78           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 976891a...66a2a16. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Oct 8, 2021

✨ Coder.com for PR #4328 deployed! It will be updated on every commit.

If you're developing code-server on Linux, make sure you have installed or install the following dependencies:

```shell
sudo apt-get install build-essential g++ libx11-dev libxkbfile-dev libsecret-1-dev python-is-python3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this also install pkg-config? Maybe g++ installs it but I am not sure.

One thing we might want to think about is that the requirements for building from source are the same as the npm requirements so I wonder if there is some clever way to avoid duplication https://github.com/cdr/code-server/blob/main/docs/npm.md#ubuntu-debian

Otherwise we will probably end up only updating one or the other and they get out of sync.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we need pkg-config, it never hurts to be explicit about it - it won't cause any harm, and package dependencies are an implementation detail that are subject to change

@jsjoeio jsjoeio force-pushed the jsjoeio-update-contributing branch 2 times, most recently from 9f09512 to 72e72a0 Compare October 28, 2021 22:55
@jsjoeio jsjoeio force-pushed the jsjoeio-update-contributing branch from 72e72a0 to 66a2a16 Compare October 29, 2021 23:34
@jsjoeio jsjoeio merged commit 9c86157 into main Nov 1, 2021
@jsjoeio jsjoeio deleted the jsjoeio-update-contributing branch November 1, 2021 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants