Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 3.19 KB
Raw

Feature Requests

Want a new feature in Mudlet? Let us know about it! We also have a long-running feature requests thread on our forums.

Bug Reports

We're sorry you've encountered an issue with Mudlet and appreciate that you're taking the time to report it to us.

To help us find & fix the problem quickest, please include:

  • as much information possible about the issue
  • your Mudlet version as it says in the About window
  • specific instructions on how to reproduce the issue if you know how to

Coding guidelines

If you're a first-timer, you're excluded, we'll go easy on you 😉

Use QLatin1String over QStringLiteral if possible

Some methods in the Qt API have overloads for either taking a QString, or a QLatin1String object. This is because Latin1 is simpler to parse than UTF-16, and therefore the QLatin1String version can be faster, and use less memory. This is worth remembering especially for some QString methods:

bool same = (str == QLatin1String("Hello"));
str.startsWith(QLatin1String("Hello"));
str += QLatin1String("World");

are more efficient than

bool same = (str == QStringLiteral("Hello"));
str.startsWith(QStringLiteral("Hello"));
str += QStringLiteral("World");

(source, additional reading)

Do not use QStringLiteral("")

Prefer QString() over QStringLiteral("") for for empty strings - the default constructor for QString is cheaper in terms of both instructions and memory.

(source)

Avoid duplicated QStringLiterals

Avoid having multiple QStringLiterals with the same content. For plain literals and QLatin1String, compilers try to consolidate identical literals so that they are not duplicated. For QStringLiteral, identical strings cannot be merged.

(source)

Internationalization do's and don'ts

Do:

  • enable strings visible in the Mudlet GUI to be translateable
  • minimise use of HTML styling tags in strings to be translated
  • enable users to use language-specific Mudlet object names (triggers, aliases, labels, etc)

Don't:

  • translate the Mudlet API: functions, events, error messages or constants (e.g. main console)
  • use numbers in the API - English words are preferred instead
  • try to assemble a sentence on the fly - English grammar does not translate into other languages. Present the full sentence to translators instead
  • assume English-centric plural forms, other languages do not necessarily have the simple add an "s"/"es" for more/less then the singular case.
  • assume universal quote and number punctuation formats. There are languages that use « and » instead of " for "quoting" words or phrases. Qt can provide Locale specific displays of numbers/dates/times.

Git commit guidelines for core team

Merging Pull Requests (PRs)

The preferred order of merging PRs is: prefer rebase, else squash if you'd like to clean up the history before merging. Avoid doing a merge commit.