Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (47 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 1.61 KB
Raw

Contributing to Hulo-Docs

Thank you for considering contributing to Hulo-Docs! 🎉
Whether you're fixing a typo, translating a guide, or writing a new tutorial — your help is appreciated.

💡 Ways to Contribute

There are several ways you can help:

  • 📖 Fixing typos or improving grammar
  • 🌐 Translating documents to other languages
  • 🧠 Adding new guides or tutorials
  • 🛠 Improving code samples or examples
  • 💅 Enhancing the theme or layout
  • 🐛 Reporting or fixing documentation bugs

🧰 Prerequisites

Make sure you have the following installed:

🚀 Getting Started

  1. Fork the repository.

  2. Clone your fork:

    git clone https://github.com/<your-username>/hulo-docs.git
cd hulo-docs

  3. Install dependencies:

    pnpm install

  4. Start the dev server:

    pnpm docs:dev

  5. Open http://localhost:8080 to preview your changes.

🧪 Before Submitting

  • Run pnpm lint to ensure your changes are formatted properly.
  • Double-check spelling and clarity of your writing.
  • For new documentation files, follow the VuePress style guide.

📦 Submitting a Pull Request

  1. Push your changes to a branch:

    git checkout -b your-branch-name
git add .
git commit -m "docs: improve docs or fix issue"
git push origin your-branch-name

  2. Open a Pull Request from your branch to the main branch.

Thank you again for helping us improve the Hulo ecosystem! ❤️