Skip to main content
Welcome to Heimerdinger.LoL! We appreciate your interest in contributing to our project. This guide provides guidelines for contributing to our user-friendly website that provides information about the game “League of Legends.”
HeimerdingerLoL isn’t endorsed by Riot Games and doesn’t reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties. Riot Games, and all associated properties are trademarks or registered trademarks of Riot Games, Inc.

Technologies Used

Our project is built with modern web technologies:

Types of Contributions

We welcome any kind of improvement to the codebase of Heimerdinger.LoL:

Bug Fixes

Help us squash bugs and improve stability

New Features

Propose and implement new functionality

Code Improvements

Refactor and optimize existing code

Documentation

Enhance documentation and guides

Getting Started

Follow these steps to start contributing:
1

Fork the repository

Create your own fork of the Heimerdinger.LoL repository on GitHub.
2

Clone your fork

Clone your fork to your local machine:
git clone https://github.com/YOUR-USERNAME/HeimerdingerLoL.git
3

Create a new branch

Create a new branch for your contribution:
git checkout -b feature/your-feature-name
4

Make your changes

Implement your bug fix, feature, or improvement.
5

Run Laravel Pint

Run Laravel Pint on your changes to ensure code style consistency, then commit:
./vendor/bin/pint
git commit -m "Your descriptive commit message"
6

Push your changes

Push your changes to your fork:
git push origin feature/your-feature-name
7

Submit a pull request

Submit a pull request to the main repository with a clear description of your changes.

Pull Request Guidelines

When submitting a pull request (PR), please ensure:
  • Clear title and description: Provide a descriptive title and detailed description of your changes
  • Reference related issues: Link to any related issues or feature requests if applicable
  • Well-documented changes: Explain the purpose and the changes made
Well-documented PRs help maintainers understand your contribution and speed up the review process.

Issue Reporting

If you encounter a bug or issue:
  1. Check existing issues: Search existing issues to see if it has already been reported
  2. Open a new issue: If not found, create a new issue with:
    • Clear description of the problem
    • Steps to reproduce the issue
    • Relevant error messages or screenshots
    • Your environment details (OS, PHP version, etc.)
Provide as much detail as possible to help us understand and address the issue quickly.

Code of Conduct

We have a code of conduct that all contributors are expected to adhere to. You can find our code of conduct in the Code of Conduct page.

Your Ideas and Feedback

Feel free to suggest new features or improvements. We appreciate all contributions and look forward to working together to make this project even better. Thank you for your contributions and support!

Build docs developers (and LLMs) love