GH-78: Add contributing docs

.env.example

@@ -3,7 +3,7 @@ VITE_APP_NAME="HytaleModding Wiki"
 APP_ENV=local
 APP_KEY=
 APP_DEBUG=true
-APP_URL=http://localhost
+APP_URL=http://localhost:8000
 
 APP_LOCALE=en
 APP_FALLBACK_LOCALE=en

CODE_OF_CONDUCT.md

@@ -0,0 +1,90 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our Hytale modding documentation community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community focused on helping everyone learn and succeed in Hytale modding.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+- Helping newcomers get started with Hytale modding
+- Sharing knowledge and resources generously
+- Providing clear, accurate documentation
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address, without their explicit permission
+- Spreading misinformation or deliberately misleading documentation
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, including but not limited to:
+
+- GitHub repositories and discussions
+- Discord servers
+- Community forums and social media
+- Virtual or in-person events representing the community
+
+It also applies when an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement via GitHub issues or Discord moderators.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

CONTRIBUTING.md

@@ -0,0 +1,178 @@
+# 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
+
+- [Code of Conduct](#code-of-conduct)
+- [How Can I Contribute?](#how-can-i-contribute)
+- [Getting Started](#getting-started)
+- [Submitting Changes](#submitting-changes)
+- [Community](#community)
+
+## Website Guides
+
+Alongside this, you are requested to follow our guides related to contributing on our website:
+
+- [PR Guidelines](https://hytalemodding.dev/en/docs/contributing/pr-guidelines)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). 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](https://bun.sh/) (install with `npm install -g bun`)
+- PHP 8.2 or higher
+- [Composer](https://getcomposer.org/) (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:
+
+```bash
+git clone https://github.com/YOUR_USERNAME/hytalemodding-wiki.git
+cd hytalemodding-wiki
+```
+
+3. Install dependencies:
+
+```bash
+composer install
+bun install
+```
+
+4. Set up your environment:
+
+```bash
+cp .env.example .env
+php artisan key:generate
+```
+
+5. Set up the database and seed it with test data:
+
+```bash
+php artisan migrate --seed
+```
+
+6. Start the development server:
+
+```bash
+composer dev
+```
+
+7. Open [http://localhost:8000](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:
+
+```bash
+git checkout -b feature/your-feature-name
+# or
+git checkout -b fix/your-bug-fix
+```
+
+2. Make your changes and commit:
+
+```bash
+git add .
+git commit -m "feat: Add clear, descriptive commit message that follow conventional commits"
+```
+
+3. Push to your fork:
+
+```bash
+git push origin feature/your-feature-name
+```
+
+4. 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](https://www.conventionalcommits.org/en/v1.0.0/), 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:
+
+```bash
+bun run lint        # ESLint
+bun run format      # Prettier
+bun run types       # TypeScript type checking
+```
+
+Or run all at once:
+
+```bash
+bun run quality
+```
+
+For PHP code, run:
+
+```bash
+./vendor/bin/pint   # Laravel Pint (code style)
+```
+
+## Community
+
+### Getting Help
+
+- **Discord**: [Join our Discord](https://discord.gg/hytalemodding) 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:
+
+- Ask in the [Discord server](https://discord.gg/hytalemodding)
+- Reach out to us via email at `hello@hytalemodding.dev`
+- [Open a discussion](https://github.com/orgs/HytaleModding/discussions) on GitHub
+
+Thank you for contributing to HytaleModding Wiki! Your efforts help the entire community learn and grow together.

README.md

@@ -2,6 +2,8 @@
 
 # HytaleModding Wiki
 
-This is the official Wiki project from HytaleModding, hosted at https://wiki.hytalemodding.dev.
+This is the official Wiki project from HytaleModding, hosted at https://wiki.hytalemodding.dev. It allows mod teams to create and manage documentation for their mods, making it easy for players and developers to find the information they need.
 
-Installation & Setup instructions are not available as of now. 
+## Contributing
+
+If you'd like to contribute to this project, you can follow our [Contributing Guide](./CONTRIBUTING.md).