|
| 1 | +# Contributing to Hulo-Docs |
| 2 | + |
| 3 | +Thank you for considering contributing to **Hulo-Docs**! 🎉 |
| 4 | +Whether you're fixing a typo, translating a guide, or writing a new tutorial — your help is appreciated. |
| 5 | + |
| 6 | +## 💡 Ways to Contribute |
| 7 | + |
| 8 | +There are several ways you can help: |
| 9 | + |
| 10 | +- 📖 Fixing typos or improving grammar |
| 11 | +- 🌐 Translating documents to other languages |
| 12 | +- 🧠 Adding new guides or tutorials |
| 13 | +- 🛠 Improving code samples or examples |
| 14 | +- 💅 Enhancing the theme or layout |
| 15 | +- 🐛 Reporting or fixing documentation bugs |
| 16 | + |
| 17 | +## 🧰 Prerequisites |
| 18 | + |
| 19 | +Make sure you have the following installed: |
| 20 | + |
| 21 | +- [Node.js](https://nodejs.org/) (>= 18) |
| 22 | +- [PNPM](https://pnpm.io/) |
| 23 | +- Git |
| 24 | + |
| 25 | +## 🚀 Getting Started |
| 26 | + |
| 27 | +1. **Fork** the repository. |
| 28 | +2. **Clone** your fork: |
| 29 | + |
| 30 | + ```bash |
| 31 | + git clone https://github.com/<your-username>/hulo-docs.git |
| 32 | + cd hulo-docs |
| 33 | + ``` |
| 34 | + |
| 35 | +3. **Install dependencies:** |
| 36 | + |
| 37 | + ```bash |
| 38 | + pnpm install |
| 39 | + ``` |
| 40 | + |
| 41 | +4. **Start the dev server:** |
| 42 | + |
| 43 | + ```bash |
| 44 | + pnpm docs:dev |
| 45 | + ``` |
| 46 | + |
| 47 | +5. Open `http://localhost:8080` to preview your changes. |
| 48 | + |
| 49 | +## 🧪 Before Submitting |
| 50 | + |
| 51 | +- Run `pnpm lint` to ensure your changes are formatted properly. |
| 52 | +- Double-check spelling and clarity of your writing. |
| 53 | +- For new documentation files, follow the [VuePress style guide](https://vuepress.vuejs.org/guide/markdown.html). |
| 54 | + |
| 55 | +## 📦 Submitting a Pull Request |
| 56 | + |
| 57 | +1. Push your changes to a branch: |
| 58 | + |
| 59 | + ```bash |
| 60 | + git checkout -b your-branch-name |
| 61 | + git add . |
| 62 | + git commit -m "docs: improve docs or fix issue" |
| 63 | + git push origin your-branch-name |
| 64 | + ``` |
| 65 | + |
| 66 | +2. Open a Pull Request from your branch to the `main` branch. |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +Thank you again for helping us improve the Hulo ecosystem! ❤️ |
0 commit comments