Contributing to Lorekeeper

Lorekeeper, much like any project in its vein, thrives on community contributions; be they bugfixes, new features, extensions, or so on, these efforts are what help make the project shine. If you are interested in contributing to core Lorekeeper, pull requests are always open at the GitHub repository.

Generally speaking, Lorekeeper and its branches are structured and maintained in keeping with GitFlow. Loosely, this means that there are two persistent branches:

• The default/primary branch-- master, in this case-- which always contains the current release, and
• The development branch-- develop, in this case-- which always contains the latest work-- features, fixes, and so on.

As well as three types of branches; each branch of these types is destined to be merged into another and is important but ultimately impermanent:

• Feature branches
  • These follow the naming scheme feature/FEATURE-NAME-HERE, i.e. feature/two-factor-auth.
  • While these are called feature branches, they can contain new features and/or non-emergency bugfixes!
  • New features are always merged into develop and this branch only.
  • Fixes, however, are somewhat more complicated.
• Hotfix branches
  • These follow the naming scheme hotfix/HOTFIX-NAME-HERE.
  • These contain emergency bugfixes, e.g. fixes for critical issues or security vulnerabilities.
  • These are directly branched off of master/the current release and merged back into master when complete.