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

guide: required software to run docs local dev (contrib) for Windows #2692

Merged
merged 14 commits into from
Oct 14, 2021

Conversation

iesahin
Copy link
Contributor

@iesahin iesahin commented Aug 5, 2021

Fix #2684

@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 5, 2021 04:43 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 5, 2021 09:25 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 5, 2021 10:51 Inactive
@iesahin iesahin requested a review from jorgeorpinel August 5, 2021 10:52
@iesahin

This comment has been minimized.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 10, 2021 06:49 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 10, 2021 06:52 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 10, 2021 11:49 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 10, 2021 12:56 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 11, 2021 08:50 Inactive
@jorgeorpinel

This comment has been minimized.

@jorgeorpinel jorgeorpinel changed the title Added links to required software for Windows. guide: required software to run docs local dev (contrib) for Windows Aug 18, 2021
@rogermparent

This comment has been minimized.

@rogermparent rogermparent temporarily deployed to dvc-org-iesahin-issue26-pww6u6 August 18, 2021 20:04 Inactive
jorgeorpinel
jorgeorpinel previously approved these changes Sep 28, 2021
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

OK if Python 2 is required. If it's 3 then please mention it for all platforms as I think most distros still come with 2 (unless I'm outdated). See #2692 (comment) above

@rogermparent
Copy link
Contributor

Seems node-gyp uses python 3.6+, according to its README

@jorgeorpinel jorgeorpinel dismissed their stale review September 29, 2021 00:16

OK thanks. Then we would need to mention py3 for all platforms I think.

@jorgeorpinel

This comment has been minimized.

Comment on lines 167 to 177
- Markdown: Neither bullet lists nor each item's should be too long (3 sentence
- Markdown: Bullet lists and their items shouldn't be too long (3 sentence
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm, this was correct before though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It was correct but neither/nor is usually for things of the same kind. I simplified the wording.

Copy link
Contributor

@jorgeorpinel jorgeorpinel Oct 14, 2021

Choose a reason for hiding this comment

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

Unresolving. OK but "something AND something should not" is even stranger language. "And" is positive, "not" is negative. It's confusing.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK I updated this...

Copy link
Member

Choose a reason for hiding this comment

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

I agree on the unrelated changes. PR should be focused (we all do this from time to time though - it's tempting to fix minor things as you go).

In this case though - does it change semantics? The way I read it - they are the same for me. Is it the case where we should have strong opinion on how it's written? My suggestion next time would be - unless it's incorrect, or significantly complicate the meaning - let's avoid discussions like this? wdyt?

Also - let's state how important for you (as a reviewer) this thing is if it's not clear. E.g. minor: blah-blah-blah. So that author could merge even if there are small things unresolved. It's never an intention to solve all minor things I guess.

Copy link
Contributor

@jorgeorpinel jorgeorpinel Oct 14, 2021

Choose a reason for hiding this comment

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

My suggestion next time would be - unless it's incorrect, or significantly complicate the meaning - let's avoid discussions like this? wdyt?
Also - let's state how important for you (as a reviewer) this thing is

I agree in general but it can be tricky once something is touched if a question comes up about the change we need to communicate somehow and for a very small PR like this one that can double the merge time. We should completely avoid unrelated changes in small PRs, some copy edits can be thrown in medium/large PRs IMO (as long as they don't make the review process harder).

BTW @iesahin I changed this and merged assuming you don't have a strong opinion (and to get this done) but I tried to address your concern when doing so. We can revisit if needed. Thanks

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

1 or 2 unrelated edits to roll back (commented above), then we can merge 👍 Thanks

@shcheklein
Copy link
Member

@jorgeorpinel hey, could we move faster with this :) (overall, let's discuss how can we do such PRs faster next retro? @iesahin @jorgeorpinel - maybe you could do regular 1-1 sync - that might help to move faster with small edits and merge these PRs faster, wdyt? :)

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

Oops this one slipped my radar last week. @iesahin please remember to re-request reviews after addressing feedback. Also this would've bene merged a long time ago if it didn't have unrelated changes.

@jorgeorpinel jorgeorpinel merged commit 086099f into master Oct 14, 2021
@jorgeorpinel jorgeorpinel deleted the iesahin/issue2684 branch October 14, 2021 19:04
@jorgeorpinel

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

guide: Improve contributing instructions for Windows
4 participants