ghmark675
55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
# 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
|
||
|
||
```bash
|
||
git clone https://github.com/<your-username>/<repository-name>.git
|
||
cd <repository-name>
|
||
```
|
||
|
||
## 3️⃣ Create a Feature Branch
|
||
|
||
```bash
|
||
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
|
||
|
||
```bash
|
||
git add .
|
||
git commit -m "type: short description"
|
||
```
|
||
|
||
> It’s recommended to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification to keep commit history clean and readable.
|
||
|
||
## 6️⃣ Push to Remote
|
||
|
||
```bash
|
||
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.
|