docs: add commit cli #657
docs: add commit cli #657
Conversation
Codecov ReportBase: 97.92% // Head: 98.09% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #657 +/- ##
==========================================
+ Coverage 97.92% 98.09% +0.17%
==========================================
Files 35 39 +4
Lines 1252 1682 +430
==========================================
+ Hits 1226 1650 +424
- Misses 26 32 +6
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
docs/commit.md
Outdated
|
|
||
| !!! note | ||
| To maintain platform compatibility, the `commit` command disable ANSI escaping in its output. | ||
| In particular pre-commit hooks coloring will be deactivated. |
There was a problem hiding this comment.
I think we can add a link to the original issue.
| @@ -110,3 +110,6 @@ venv.bak/ | |||
|
|
|||
| # build | |||
| poetry.lock | |||
|
|
|||
| # macOSX | |||
There was a problem hiding this comment.
I'd suggest we don't add it to project .gitignore. It should be added to somewhere like ~/.gitignore based on platform's need
There was a problem hiding this comment.
Before removing it let me fight a bit for this modification:
.DS_Store files are generated by mac computer all the time. Lucky me I didn’t execute the lib itself so there is just one but they can appear in any folder. All Mac IDE are hiding them from us meaning that before git add I simply don’t know where they are. If you refuse to add this line to the .gitignore you simply deny to all mac users the possibility to use git add . which can be a real pain when modifying many files.
Let’s have a look at the .gitignore itself. it’s not a « commitizen » specific file but the github template for Python language with small customization. It includes:
- IDE specific folders (.vscode)
- sphinx folders (docs/_build/)
- all the django related files
- translation files (.mo, .po)
- scrappy stuff
- All the distribution files including things unrelated to the project
- unitesting from the most known tools (coverage, nosetest and tox) even though tox is not part of your lib
meaning that the .gitignore already includes things that no developer will ever need as it’s unrelated to the project. I don’t understand why 1 extra line that will be useful for all mac users seems too much. it’s present in all the open-source projects I contribute in like: opensartoolkit, pydata-sphinx-theme, sepal_ui, pygadm
let me know if even after my little speech you still want me to remove it and I will. 😢
There was a problem hiding this comment.
Hi @12rambau thanks for sharing the thought in such detail! tl;dr, you convinced me to accept it in this project.
I just found out we also add .idea and .vscode into the .gitignore. Thus, adding .DS_Store could make sense to this project.
Not adding these stuff is kinda my personal preference which was suggested by others back to the time I contributed to git-extras. They suggested me adding these config to my local development environment. Otherwise, we'll need to add lots and lots different kinds of temp file and config into .gitignore. Just share the reason why I asked you to remove it at the first place 🙂
Description
Create a dedicated page for the
commitcommand and document the drop of hooks coloring.Fix #417
Checklist
./scripts/formatand./scripts/testlocally to ensure this change passes linter check and testSteps to Test This Pull Request
check the new doc :-)