Difference between revisions of "Contributing to Lorekeeper"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Created page with "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 p...")
 
Tag: 2017 source edit
Line 3: Line 3:
 
Generally speaking, Lorekeeper and its branches are structured and maintained in keeping with [https://datasift.github.io/gitflow/IntroducingGitFlow.html GitFlow]. Loosely, this means that there are two persistent branches:  
 
Generally speaking, Lorekeeper and its branches are structured and maintained in keeping with [https://datasift.github.io/gitflow/IntroducingGitFlow.html GitFlow]. Loosely, this means that there are two persistent branches:  
  
* The default/primary branch-- <u>master</u>, in this case-- which always contains the current release, and
+
*The default/primary branch-- <u>master</u>, in this case-- which always contains the current release, and
* The development branch-- <u>develop</u>, in this case-- which always contains the latest work-- features, fixes, and so on.
+
*The development branch-- <u>develop</u>, in this case-- which always contains the latest work-- features, fixes, and so on.
  
<br />
+
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 <code>feature/FEATURE-NAME-HERE</code>.

Revision as of 11:35, 6 May 2021

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.