Skip to content

CONTRIBUTING-EN.md

Latest commit

 

History

History
54 lines (35 loc) · 1.43 KB

CONTRIBUTING-EN.md

File metadata and controls

54 lines (35 loc) · 1.43 KB

Contribution Guide

Thank you for your interest in contributing to this project! To maintain high code quality and clear version management, please follow the steps below when submitting your changes.

🪄 How to Submit a Pull Request (PR)

1️⃣ Fork the Repository

Fork this repository to your own GitHub account.

2️⃣ Clone to Local

git clone https://github.com/<your-username>/<repository-name>.git
cd <repository-name>

3️⃣ Create a Feature Branch

git checkout -b feature/your-feature-name

Recommended naming convention: feature/xxx or fix/xxx, to easily distinguish between new features and bug fixes.

4️⃣ Develop and Test

  • Make your code changes while keeping the project’s coding style consistent.
  • Ensure that all new features or fixes pass the necessary tests.

5️⃣ Commit Your Changes

git add .
git commit -m "type: short description"

It’s recommended to follow the Conventional Commits specification to keep commit history clean and readable.

6️⃣ Push to Remote

git push origin feature/your-feature-name

7️⃣ Open a Pull Request

  1. On GitHub, click New Pull Request.

  2. The target branch must be the main branch of this repository.

  3. Fill in the PR description:

    • Describe the main changes you made.
    • If related issues exist, please link them in the PR.