Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (42 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 2.03 KB

Contributing to MythicPlusTracker

Thank you for your interest in contributing! This document explains how to report issues, submit pull requests, and add localizations.

Reporting Bugs

  1. Check existing issues to avoid duplicates.
  2. Open a new issue with:
    • A clear title and description.
    • Steps to reproduce the problem.
    • Your WoW version and addon version (shown in chat on login).
    • Any relevant error output from the Lua error frame.

Pull Requests

  1. Fork the repository and create a branch from develop.
  2. Keep changes focused — one feature or fix per pull request.
  3. Follow the existing code style (see below).
  4. Test your changes in-game before submitting.
  5. Write a clear PR description explaining what changed and why.

Code Style

  • Every file starts with local addonName, addon = ... — use addon as the shared namespace.
  • Attach module globals with the MPT_* prefix (e.g. MPT_MAIN, MPT_Dashboard).
  • Never use print() directly — use the addon.*Message() helpers (addonMessage, chatMessage, errorMessage, etc.).
  • Never hardcode color escape codes — use addon.colors.* and always close with addon.colors.RESET.
  • New files must be registered in the correct .xml or .toc file at the correct load-order position.

Adding Locales

  1. Open Locales/en-US.lua and copy the locale table as a reference.
  2. Create a new file Locales/<locale-code>.lua (e.g. fr-FR.lua).
  3. Translate all string values — do not change the keys.
  4. Register the new file in Locales/locales.xml.
  5. Submit a pull request with your new locale file and the updated locales.xml.

Commit Messages

Follow Conventional Commits:

<type>(<scope>): <short summary>

Common types: feat, fix, docs, style, refactor, chore.
Keep the header under 50 characters. Wrap the body at 72 characters.

Questions?

Open a GitHub Discussion or create an issue with the question label.