Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
178 lines (114 loc) · 4.25 KB

CONTRIBUTING.md

File metadata and controls

178 lines (114 loc) · 4.25 KB

Contributing to HytaleModding Wiki

Thank you for your interest in contributing to the HytaleModding Wiki project! This is a community-driven initiative, and we welcome contributions from modders, developers, designers, and documentation enthusiasts of all skill levels.

Table of Contents

Website Guides

Alongside this, you are requested to follow our guides related to contributing on our website:

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

How Can I Contribute?

We welcome suggestions for new features or improvements:

  • Search existing issues first to avoid duplicates
  • Clearly describe the enhancement and its benefits
  • Explain why this would be useful to the Hytale modding community

Getting Started

Prerequisites

  • Node.js 18.x or higher
  • Bun (install with npm install -g bun)
  • PHP 8.2 or higher
  • Composer (PHP dependency manager)
  • Git
  • A text editor (VS Code, Cursor, etc.)

PHP Extensions

Make sure the following PHP extensions are enabled in your php.ini:

  • fileinfo
  • pdo_sqlite
  • sqlite3

Local Development Setup

  1. Fork the repository on GitHub

  2. Clone your fork:

git clone https://github.com/YOUR_USERNAME/hytalemodding-wiki.git
cd hytalemodding-wiki
  1. Install dependencies:
composer install
bun install
  1. Set up your environment:
cp .env.example .env
php artisan key:generate
  1. Set up the database and seed it with test data:
php artisan migrate --seed
  1. Start the development server:
composer dev
  1. Open http://localhost:8000 in your browser

Demo Accounts

After seeding, you can log in with:

  • admin@example.com (password: password)
  • user@example.com (password: password)
  • collaborator@example.com (password: password)

Submitting Changes

Branch Workflow

  1. Create a new branch for your changes:
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix
  1. Make your changes and commit:
git add .
git commit -m "feat: Add clear, descriptive commit message that follow conventional commits"
  1. Push to your fork:
git push origin feature/your-feature-name
  1. Open a Pull Request on GitHub

Pull Request Guidelines

You must include a GitHub issue number while making a PR, attach your GitHub issue by prefixing your PR title with GH-<issue number>

Commit Messages

We use Conventional Commits, and you are supposed to use those commits while contributing to us. Your PR will not be accepted if you do not use conventional commits

Code Quality

Before submitting, ensure your code passes linting and type checks:

bun run lint        # ESLint
bun run format      # Prettier
bun run types       # TypeScript type checking

Or run all at once:

bun run quality

For PHP code, run:

./vendor/bin/pint   # Laravel Pint (code style)

Community

Getting Help

  • Discord: Join our Discord for help while writing guides, remember, we are here to help you if you want to contribute!
  • GitHub Discussions: Ask questions and share ideas
  • Issues: Report bugs and request features

Recognition

Contributors are recognized in several ways:

  • Listed in the repository's contributors
  • Building a portfolio of open source work

Questions?

If you have questions not covered in this guide:

Thank you for contributing to HytaleModding Wiki! Your efforts help the entire community learn and grow together.