Skip to content

🙌 Get Involved

We warmly welcome all types of contributions! SuzuBlog is an open-source project, and we aim to provide a minimalist, powerful blogging template for the community. If you have ideas, suggestions, or bug reports, we’d love to have you join us!

🚀 Quick Start

1. Fork the Repository

Click Fork on the SuzuBlog GitHub repository to create a copy in your account.

2. Clone the Repository Locally

bash
git clone https://github.com/<your-username>/SuzuBlog.git
cd SuzuBlog

3. Install Dependencies

Use pnpm for dependency management:

bash
pnpm install

4. Start the Development Server

bash
pnpm dev

Open your browser and navigate to http://localhost:3000 to preview your local version.

📋 Contribution Guidelines

Before contributing, please make sure to read the following:

  1. Code of Conduct

    • Ensure that you adhere to our community Code of Conduct by maintaining a friendly and professional attitude.
  2. Contributing Guide

    • This guide outlines how to contribute to the project, including how to submit issues, the Pull Request process, and coding standards.

🌟 Contributors

A huge thank you to everyone who has contributed to SuzuBlog! Your support makes this project stronger ❤️

Contributors

Check out the latest contributors here.

💡 How to Contribute

Report Bugs or Suggest Features

  • Submit bug reports via Issues.
  • Follow the Issue template.
  • Please include as much detail as possible:
    • A clear description of the bug.
    • Steps to reproduce the issue.
    • Any relevant screenshots or logs.
  • If you have feature suggestions, feel free to open an issue to share your ideas.

Submit Code

  • Implement your changes locally and create a Pull Request.
  • Ensure that your code follows the project's standards outlined in the Contributing Guide.

📬 Contact

If you have any questions about contributing, feel free to reach out via GitHub Issues or email us.

We look forward to your contributions! 💖

This docs Licensed under CC BY 4.0