Contributing

If you want to contribute to Questie there're several ways how you can do it.

First of all you can have a look at the issues and check if you can add helpful information to the existing ones. Quest issues should be an easy starting point. They need an investigation of the information listed in the Quest Database with all the connected NPCs, items and objects.

Moreover for those of you who are already familiar with Lua and Addon development the issue labels bug and feature request might be interesting. You can also have a look at the Debugging page for some nice tricks and the Database Structure for additional information to the way Questies stores its data (both pages are very WIP).

Useful links

• Global functions of the WoW API
• Events the API can fire

Development Environment

Basically you can use any (Text-)editor which fits you. We recommend the use of IntelliJ + EmmyLua or Visual Studio Code/VSCodium with this Lua Extension.

Commit messages and changelog

The changelog is generated by the changelog.py script. This script iterates all commits since the last git tag and searches for commits with specific prefixes. These prefixes are:

prefix	usage	example
[quest]	Whenever a data correction changes/fixes the objectives, requirements, starting locations, etc.	[quest] Fix pre quest for "Warm Welcome"
[db]	Whenever a data correction does not directly affect a quest, but for example updates the spawn locations of an NPC	[db] Fix location of "Lar'korwi"
[fix]	Whenever a logic bug and/or Lua error is fixed	[fix] Fix DMF dates for Era/HC
[feature]	Whenever something entirely new is added or an existing functionality is fundamentally changed	[feature] Add gold reward to quest details
[locale]	Whenever anything translation related is updated. Specific languages can be targeted with another prefix (e.g. [locale][deDE] for German translation changes	[locale] Add translation for "Next in chain"

⚠️ When mixing changes in a single Pull Request, it is really helpful when the commits are labeled correctly. If you want a commit message to show up in the changelog, then you have to use one of the prefixes above (try to use a proper description). If you want a commit message to not show up, don't use a prefix.

For further guidelines or if you have any questions feel free to contact us on our Discord.