Skip to content
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

Improve contributing documentation for Windows development #795

Merged
merged 11 commits into from
Jun 30, 2022

Conversation

w84thesun
Copy link
Contributor

@w84thesun w84thesun commented Jun 28, 2022

Description

This PR refs #388.

Add more documentation for Windows contributors. Show how to run commands, what works and what's not.

@w84thesun w84thesun added documentation Something user-visible is badly or not documented code/chore Code maintenance improvements labels Jun 28, 2022
@w84thesun w84thesun added this to the v0.5.0 milestone Jun 28, 2022
@w84thesun w84thesun self-assigned this Jun 28, 2022
@codecov
Copy link

codecov bot commented Jun 28, 2022

Codecov Report

Merging #795 (d6b0900) into main (db9698f) will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #795      +/-   ##
==========================================
- Coverage   59.51%   59.47%   -0.04%     
==========================================
  Files         214      214              
  Lines        9447     9447              
==========================================
- Hits         5622     5619       -3     
- Misses       3174     3176       +2     
- Partials      651      652       +1     
Impacted Files Coverage Δ
internal/util/version/version.go 55.00% <0.00%> (-5.00%) ⬇️
Flag Coverage Δ
FerretDB 61.98% <ø> (-0.04%) ⬇️
MongoDB 7.39% <ø> (-0.04%) ⬇️
integration 62.08% <ø> (-0.04%) ⬇️
unit 27.44% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

@w84thesun w84thesun removed the documentation Something user-visible is badly or not documented label Jun 28, 2022
@w84thesun w84thesun requested review from a team, rumyantseva, seeforschauer and noisersup and removed request for a team June 28, 2022 10:55
@w84thesun w84thesun marked this pull request as ready for review June 28, 2022 10:55
@w84thesun w84thesun requested a review from AlekSi as a code owner June 28, 2022 10:55
rumyantseva
rumyantseva previously approved these changes Jun 28, 2022
Copy link
Contributor

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

LGTM.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@seeforschauer
Copy link
Contributor

Would you please run task fmt also - check dirty fails. :)

seeforschauer
seeforschauer previously approved these changes Jun 28, 2022
@w84thesun w84thesun enabled auto-merge (squash) June 28, 2022 13:21
rumyantseva
rumyantseva previously approved these changes Jun 28, 2022
Copy link
Contributor

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@AlekSi AlekSi left a comment

Choose a reason for hiding this comment

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

I feel like I need to understand Windows problems better. Let's do a call later today

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@w84thesun w84thesun dismissed stale reviews from rumyantseva and seeforschauer via be55a6f June 29, 2022 07:29
rumyantseva
rumyantseva previously approved these changes Jun 29, 2022
Copy link
Contributor

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

LGTM

AlekSi
AlekSi previously approved these changes Jun 30, 2022
@AlekSi
Copy link
Member

AlekSi commented Jun 30, 2022

Had a call with Dmitry to discuss how WSL 2 works. It is pretty cool, but connectivity between WSL VMs (that share the same kernel!) is quite complicated. Rewrote text to shift accent to the fact that "WSL 2 distros" are not supported.

@seeforschauer @rumyantseva PTAL

@AlekSi AlekSi disabled auto-merge June 30, 2022 13:43
@AlekSi AlekSi enabled auto-merge (squash) June 30, 2022 13:43
@AlekSi AlekSi linked an issue Jun 30, 2022 that may be closed by this pull request
4 tasks
@AlekSi AlekSi merged commit 3c8ad72 into FerretDB:main Jun 30, 2022
@w84thesun w84thesun deleted the improve-docs-for-windows-contributing branch July 4, 2022 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code/chore Code maintenance improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Windows (with WSL2) development support
4 participants