doc(#318): add documentation about WinError 995

[Bogay]

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]

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

[Lee-W]

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]

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

[Lee-W]

I still see the warning here.

Maybe you could try the following command to fix it

git remote add upstream [email protected]:commitizen-tools/commitizen.git git fetch upstream git rebase -i remotes/upstream/main

[codecov]

Codecov Report

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

@@ 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]

@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?

[Lee-W]

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