Skip to content

Set up the environment and add organize/coc.md#1

Open
CYFish wants to merge 10 commits intomainfrom
dev
Open

Set up the environment and add organize/coc.md#1
CYFish wants to merge 10 commits intomainfrom
dev

Conversation

@CYFish
Copy link
Copy Markdown
Collaborator

@CYFish CYFish commented Feb 4, 2024

  1. Use PDM to manage packages
  2. Install MkDocs and configure the environment
  3. Add organize/coc.md

Copy link
Copy Markdown
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

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

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

Comment thread README.md
@Lee-W
Copy link
Copy Markdown
Member

Lee-W commented Mar 23, 2025

Hey @CYFish , thanks for coming back. Tool chains change a bit these days. Wanna play with uv instead?

@CYFish
Copy link
Copy Markdown
Collaborator Author

CYFish commented Mar 23, 2025

Sure. Give me some time to explore it 😁

@CYFish
Copy link
Copy Markdown
Collaborator Author

CYFish commented Apr 9, 2025

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.

Comment thread pyproject.toml
description = "Default template for PDM package"
readme = "README.md"
requires-python = ">=3.13"
dependencies = [
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.

nit: I think we can make commitizen and pre-commit dev dependencies

Comment thread pyproject.toml
[project]
name = "pycontw-documentation"
version = "0.1.0"
description = "Default template for PDM package"
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.

This description is not accurate now

Comment thread main.py
@@ -0,0 +1,6 @@
def main():
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.

I don't think we need this file.

Comment thread .pre-commit-config.yaml
- id: no-commit-to-branch

- repo: https://github.com/commitizen-tools/commitizen
rev: v3.15.0
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.

I think we can use the latest version haha

Suggested change
rev: v3.15.0
rev: v4.6.0

Comment thread docs/organize/coc.md
Comment on lines +59 to +60
2. Winnie (PyCon TW 2023 大會主席, winniepopu@python.tw)
3. Pochun (PyCon TW 2023 大會主席, pochunlu@python.tw)
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.

Suggested change
2. Winnie (PyCon TW 2023 大會主席, winniepopu@python.tw)
3. Pochun (PyCon TW 2023 大會主席, pochunlu@python.tw)

I guess we don't need to include their mail for now

Comment thread docs/organize/coc.md
Comment on lines +66 to +67
2. Winnie (Chairperson of PyCon TW 2023, winniepopu@python.tw)
3. Pochun (Chairperson PyCon TW 2023, pochunlu@python.tw)
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.

Suggested change
2. Winnie (Chairperson of PyCon TW 2023, winniepopu@python.tw)
3. Pochun (Chairperson PyCon TW 2023, pochunlu@python.tw)

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.

2 participants