◐ Shell
reader mode source ↗
Skip to content

doc(#318): add documentation about WinError 995#431

Merged
Lee-W merged 9 commits into
commitizen-tools:masterfrom
Bogay:doc/issue-318
Oct 9, 2021
Merged

doc(#318): add documentation about WinError 995#431
Lee-W merged 9 commits into
commitizen-tools:masterfrom
Bogay:doc/issue-318

Conversation

@Bogay

@Bogay Bogay commented Sep 26, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Add some description related to #318 so that others may find the solution on documentation.

Checklist

  • Add test cases to all the changes you introduce
  • Run ./script/format and ./script/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

Steps to Test This Pull Request

Additional context

Lee-W
Lee-W reviewed Sep 26, 2021
View reviewed changes

@Lee-W Lee-W left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

Other than the minor documentation reword. Everything looks good. Thanks!

@Bogay Bogay requested a review from Lee-W September 28, 2021 08:38
Lee-W
Lee-W requested changes Sep 30, 2021
View reviewed changes

@Lee-W Lee-W left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

Hi, sorry for the late review. As PyCon TW approaches, I get less time to devote to this project. Here are some errors I found on the changes.

You could test out through

poetry run mkdocs build
poetry run mkdocs serve

Would be great if you could add these commands to "how to contribute" so that others can have a better idea on how to test documentation changes

@Lee-W

Lee-W commented Sep 30, 2021

Copy link
Copy Markdown
Member

Also, you might need to rebase the latest master branch into this branch to pass the test fail

@Lee-W

Lee-W commented Oct 4, 2021

Copy link
Copy Markdown
Member

I still see the warning here.
image

Maybe you could try the following command to fix it

git remote add upstream git@github.com:commitizen-tools/commitizen.git
git fetch upstream 
git rebase -i remotes/upstream/main

Bogay and others added 3 commits October 6, 2021 23:07
@Bogay @Lee-W
docs(faq): reword FAQ about WinError 995 …
ca33228 
Provide the accurate versions that should solve this issue.
@Bogay @Lee-W
docs: replace htperlinks' URL with filename …
4b7604e 
According to mkdoc documentation, link to another page in the same documentation can directly use file path.

mkdoc documentation: https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages
@Lee-W
style(github-template): remove trailing space
6e567f9
@codecov

codecov Bot commented Oct 6, 2021 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Merging #431 (adea200) into master (7b7b0c9) will decrease coverage by 0.54%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #431      +/-   ##
==========================================
- Coverage   97.92%   97.37%   -0.55%     
==========================================
  Files          39       39              
  Lines        1395     1409      +14     
==========================================
+ Hits         1366     1372       +6     
- Misses         29       37       +8
Flag Coverage Δ
unittests 97.37% <ø> (-0.55%) ⬇️

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

Impacted Files Coverage Δ
commitizen/config/base_config.py 90.47% <0.00%> (-9.53%) ⬇️
commitizen/cz/base.py 97.22% <0.00%> (-2.78%) ⬇️
commitizen/cli.py 95.45% <0.00%> (-2.17%) ⬇️
commitizen/git.py 97.95% <0.00%> (-2.05%) ⬇️
commitizen/__main__.py 0.00% <0.00%> (ø)

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 7d2c3c2...adea200. Read the comment docs.

@Bogay

Bogay commented Oct 7, 2021

Copy link
Copy Markdown
Contributor Author

@Lee-W sorry for lately fix and thank you for helping me to rebase the upstream. I have finished those changes.
But the test coverage seems to decrease a little, I have no idea about that. Did I break something?

@Bogay Bogay requested a review from Lee-W October 7, 2021 08:09
@Bogay @Lee-W
docs(config): fix broken links …
adea200 
These reference-style links should in `[link][id]` format instead of `[link](id)`.
@Lee-W

Lee-W commented Oct 9, 2021

Copy link
Copy Markdown
Member

@Bogay hmmm... that's weird. sometimes codecov just acts weird. never mind, let's merge it

@Lee-W Lee-W merged commit 1ea05ac into commitizen-tools:master Oct 9, 2021
@Bogay Bogay mentioned this pull request Nov 18, 2021
Closed
@Bogay Bogay deleted the doc/issue-318 branch November 20, 2021 02:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lee-W Lee-W

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Bogay @Lee-W