Skip to content

Conversation

@Ahzyuan
Copy link
Member

@Ahzyuan Ahzyuan commented Jun 22, 2025

Prep Steps

Before we dive in, let's confirm you've unlocked all these steps

  • πŸ” I've checked for duplicate PRs (click to check)
  • πŸ“œ I've followed contribution guidelines
    • ✨ I've linted and formatted my code (how?)
    • πŸ”§ I've formatted the PR title appropriately (how?)
    • 🎯 I've targeted the master branch (how?)
    • πŸ‘ I've allowed maintainer edits on my branch (how? β†’ See step 6)
  • πŸ›‘οΈ I've added/updated tests to cover my changes if prossible (how?)
  • πŸ“ I've added/updated the documentation for any new logic introduced (how?)
  • ⏳ I understand @Ahzyuan has been busy lately and may need time to review. (we appreciate your patience!)

Type of changes

  • 🐞 Bug fix
  • 🌟 New feature
  • πŸ§ͺ Tests
  • πŸ— Refactoring
  • ⚑ Performance improvement
  • πŸ“– Documentation / docstrings
  • ↩️ Revert
  • 🧩 Other

Description

Purpose

This PR is for better README readability and repo management standardization.

Changes:

  • README.md: fix typo in installation and add download badge.
  • CODE_OF_CONDUCT.md: enhance the expression of our code of conduct

@Ahzyuan Ahzyuan self-assigned this Jun 22, 2025
@github-actions github-actions bot added the docs Update or improve the documentation or README. label Jun 22, 2025
@Ahzyuan Ahzyuan merged commit 0fcfcaf into master Jun 22, 2025
1 check passed
@Ahzyuan Ahzyuan deleted the docs/improve-readme branch June 22, 2025 08:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Update or improve the documentation or README.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant