Set up the environment and add organize/coc.md #1
Conversation
CYFish
commented
Feb 4, 2024
CYFish
commented
- Use PDM to manage packages
- Install MkDocs and configure the environment
- Add organize/coc.md
There was a problem hiding this comment.
Is there anything we want to test in this repo? Or should we remove tests/__init__.py?
Also, it might make sense for us to use pre-commit hooks like https://github.com/pycontw/pycontw-blog/blob/main/.pre-commit-config.yaml#L19-L22 and https://github.com/pycontw/pycontw-blog/blob/be772415f6a134b68b035e10e3023198478c3197/.pre-commit-config.yaml#L2-L11.
If we're to following conventional commit, https://github.com/pycontw/pycontw-blog/blob/be772415f6a134b68b035e10e3023198478c3197/.pre-commit-config.yaml#L13-L17 is handy as well
|
Sure. Give me some time to explore it 😁 |
|
Hi @Lee-W I have used uv as the package manager and added a README.md file and pre-commit hooks following the recommendations. Welcome any feedback on anything I might have missed. |
| description = "Default template for PDM package" | ||
| readme = "README.md" | ||
| requires-python = ">=3.13" | ||
| dependencies = [ |
There was a problem hiding this comment.
nit: I think we can make commitizen and pre-commit dev dependencies
| [project] | ||
| name = "pycontw-documentation" | ||
| version = "0.1.0" | ||
| description = "Default template for PDM package" |
There was a problem hiding this comment.
This description is not accurate now
| @@ -0,0 +1,6 @@ | |||
| def main(): | |||
| - id: no-commit-to-branch | ||
|
|
||
| - repo: https://github.com/commitizen-tools/commitizen | ||
| rev: v3.15.0 |
There was a problem hiding this comment.
I think we can use the latest version haha
| rev: v3.15.0 | |
| rev: v4.6.0 |
| 2. Winnie (PyCon TW 2023 大會主席, [email protected]) | ||
| 3. Pochun (PyCon TW 2023 大會主席, [email protected]) |
There was a problem hiding this comment.
| 2. Winnie (PyCon TW 2023 大會主席, [email protected]) | |
| 3. Pochun (PyCon TW 2023 大會主席, [email protected]) |
I guess we don't need to include their mail for now
| 2. Winnie (Chairperson of PyCon TW 2023, [email protected]) | ||
| 3. Pochun (Chairperson PyCon TW 2023, [email protected]) |
There was a problem hiding this comment.
| 2. Winnie (Chairperson of PyCon TW 2023, [email protected]) | |
| 3. Pochun (Chairperson PyCon TW 2023, [email protected]) |
2 participants
