pref: optimize post gen project file

[Undertone0809]

Summary by CodeRabbit

• Documentation
  • Updated contact email for reporting conduct violations.
  • Provided new installation instructions for the Python package template.
  • Included updated package template version in installation commands.
  • Enhanced instructions for running code style checks.

[coderabbitai]

Walkthrough

The project has updated its community standards and installation process. The Code of Conduct now directs reports of abuse to a new email address. The README files, both in English and Chinese, reflect a version bump in the Python package template and a revised installation command. Additionally, there's been a refinement in the post-generation script of the project, which affects module naming and code style instructions.

Changes

File(s)	Change Summary
CODE_OF_CONDUCT.md	Updated contact email for reporting abuse.
README.md, README_zh.md	Updated package template command from v1.1.5 to v1.1.6.
.../post_gen_project.py	Modified module name generation and codestyle instructions.

🐇✨
To code, we hop, with updates anew,
A version ticked, and an email, too.
With templates fresh and conduct quite clear,
We code with joy, with CodeRabbit here! 🚀🎉

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e44615d and 8062cb2.

Files ignored due to path filters (1)

• pyproject.toml is excluded by: !**/*.toml

Files selected for processing (4)

• CODE_OF_CONDUCT.md (1 hunks)
• README.md (2 hunks)
• README_zh.md (2 hunks)
• hooks/post_gen_project.py (2 hunks)

Files skipped from review due to trivial changes (2)

• README.md
• README_zh.md

Additional comments: 3

hooks/post_gen_project.py (2)

• 11-11: The project module name generation logic has been simplified by removing the replacement of hyphens with underscores. This change assumes that hyphens are no longer valid or desired in project names. Confirm that this assumption is correct and that no existing functionality relies on the old naming convention.
• 87-87: The instruction for running code style checks has been updated from make polish-codestyle to make formatting. Ensure that the Makefile has been updated accordingly to reflect this new command and that it is working as intended.

CODE_OF_CONDUCT.md (1)

• 58-58: The contact email address for reporting misconduct has been updated to "[email protected]". Ensure that this email address is correct and that the responsible party is aware of their role in handling Code of Conduct violations.