mirror of
https://gitee.com/HuLaSpark/HuLa.git
synced 2024-11-29 10:18:35 +08:00
76 lines
2.4 KiB
Markdown
76 lines
2.4 KiB
Markdown
# HuLa - Contributing Guide 🌟
|
|
|
|
We're thrilled that you want to contribute to HuLa! 😄
|
|
|
|
HuLa is an open-source project, and we welcome your collaboration. Before you jump in, let's make sure you're all set to contribute effectively and have loads of fun along the way!
|
|
|
|
## Fork the Repository
|
|
|
|
🍴 Fork this repository to your GitHub account by clicking the "Fork" button at the top right. This creates a personal copy of the project you can work on.
|
|
|
|
## Clone Your Fork
|
|
|
|
📦 Clone your forked repository to your local machine using the `git clone` command:
|
|
|
|
```bash
|
|
git clone https://github.com/HuLaSpark/HuLa.git
|
|
```
|
|
|
|
## Create a New Branch
|
|
|
|
🌿 Create a new branch for your contribution. This helps keep your work organized and separate from the main codebase.
|
|
|
|
```bash
|
|
git checkout -b your-branch-name
|
|
```
|
|
|
|
Choose a meaningful branch name related to your work. It makes collaboration easier!
|
|
|
|
## Code Like a Wizard
|
|
|
|
🧙♀️ Time to work your magic! Write your code, fix bugs, or add new features. Be sure to follow our project's coding style. You can check if your code adheres to our style using:
|
|
|
|
```bash
|
|
pnpm run lint:staged
|
|
```
|
|
|
|
This adds a bit of enchantment to your coding experience! ✨
|
|
|
|
## Committing Your Work
|
|
|
|
📝 Ready to save your progress? Commit your changes to your branch.
|
|
|
|
```bash
|
|
pnpm run commit
|
|
```
|
|
|
|
This will commit all the files to git, Please keep your commits focused and clear. And remember to be kind to your fellow contributors; keep your commits concise.
|
|
|
|
## Sync with Upstream
|
|
|
|
⚙️ Periodically, sync your forked repository with the original (upstream) repository to stay up-to-date with the latest changes.
|
|
|
|
```bash
|
|
git remote add upstream https://github.com/HuLaSpark/HuLa.git
|
|
git fetch upstream
|
|
git merge upstream/master
|
|
```
|
|
|
|
This ensures you're working on the most current version of HuLa. Stay fresh! 💨
|
|
|
|
## Open a Pull Request
|
|
|
|
🚀 Time to share your contribution! Head over to the original HuLa repository and open a Pull Request (PR). Our maintainers will review your work.
|
|
|
|
## Review and Collaboration
|
|
|
|
👓 Your PR will undergo thorough review and testing. The maintainers will provide feedback, and you can collaborate to make your contribution even better. We value teamwork!
|
|
|
|
## Celebrate 🎉
|
|
|
|
Congratulations! Your contribution is now part of HuLa. 🥳
|
|
|
|
Thank you for making HuLa even more magical. We can't wait to see what you create! 🌠
|
|
|
|
Happy Coding! 🚀
|