Updating Lorekeeper - Revision history

Mercury at 17:11, 21 November 2021

2021-11-21T17:11:50Z

Mercury at 17:31, 9 May 2021

2021-05-09T17:31:19Z

Mercury: Protected "Updating Lorekeeper": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2021-05-08T23:09:34Z

Protected "Updating Lorekeeper": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

Mercury at 23:09, 8 May 2021

2021-05-08T23:09:04Z

Mercury at 23:05, 8 May 2021

2021-05-08T23:05:49Z

Mercury at 21:46, 8 May 2021

2021-05-08T21:46:18Z

Mercury at 21:39, 8 May 2021

2021-05-08T21:39:57Z

Mercury: Created page with "
"

2021-05-08T20:41:33Z

Created page with "<blockquote></blockquote>"

New page

@@ Line 8: / Line 8: @@
 The core Lorekeeper repository, or repo, has several different branches corresponding to different kinds and stages of development. There are two that are always present:
-*<u>master</u>, which always has the latest '''stable release''' of Lorekeeper. You can always pull this!
+*<u>main</u>, which always has the latest '''stable release''' of Lorekeeper. You can always pull this!
 *<u>develop</u>, which always has the latest '''updates and new features''', but this means it's the '''least stable'''. You can always pull this, but be aware that changes will be more frequent and bugs more likely!
-"Stable", here, means that '''no new features are being added'''. Any change in the code in <u>master</u>, for instance, comes from either a new release or hotfix (which are only for critical issues!). This also tends to mean fewer bugs, as ideally most are caught and fixed before a a new version is released, and the lack of change means new bugs don't occur. Conversely, <u>develop</u> is the exact opposite: it always has the latest features, updates, etc.! Of course, this means that it always has the latest bugs. Similarly, new releases-- or updates to <u>master</u>-- happen relatively infrequently, while <u>develop</u> may be updated and added to at any time!
+"Stable", here, means that '''no new features are being added'''. Any change in the code in <u>main</u>, for instance, comes from either a new release or hotfix (which are only for critical issues!). This also tends to mean fewer bugs, as ideally most are caught and fixed before a a new version is released, and the lack of change means new bugs don't occur. Conversely, <u>develop</u> is the exact opposite: it always has the latest features, updates, etc.! Of course, this means that it always has the latest bugs. Similarly, new releases-- or updates to <u>main</u>-- happen relatively infrequently, while <u>develop</u> may be updated and added to at any time!
 There are also three different ''types'' of branches. Branches of these types are temporary, and used primarily to keep code organized before it is merged into another branch. These types are:
@@ Line 26: / Line 26: @@
 **These follow the naming scheme <code>hotfix/HOTFIX-NAME-HERE</code>.
 **These contain emergency bugfixes, e.g. fixes for critical issues or security vulnerabilities.
-**'''<u>Do not pull these</u>!''' There is no guarantee that the code in them is ready for use and you are liable to break your site if you merge their contents into your site prematurely. They will be merged into <u>master</u> if/when they are approved.
+**'''<u>Do not pull these</u>!''' There is no guarantee that the code in them is ready for use and you are liable to break your site if you merge their contents into your site prematurely. They will be merged into <u>main</u> if/when they are approved.
 ===Which branch do I pull?===
 The answer to this question depends on whether you really need the latest features and/or how willing you're willing to handle potential bugs/bug reports, as well as how often you want to update your site. In summary:
-*<u>master</u>
+*<u>main</u>
 **Most stable
 **Updates least frequently
@@ Line 44: / Line 44: @@
 **Liable to have the most bugs!
-Regardless of which you choose, remember that you only need to pull one of them to receive all relevant updates for that branch! That is, any updates from one branch that apply to another will always be merged into the latter branch by contributors-- so if there is, for instance, a hotfix that is merged into <u>master</u>, but you are currently pulling the latest release branch, you don't need to pull <u>master</u> as well; the hotfix will also be merged into the release branch!
+Regardless of which you choose, remember that you only need to pull one of them to receive all relevant updates for that branch! That is, any updates from one branch that apply to another will always be merged into the latter branch by contributors-- so if there is, for instance, a hotfix that is merged into <u>main</u>, but you are currently pulling the latest release branch, you don't need to pull <u>main</u> as well; the hotfix will also be merged into the release branch!
 ==Update Announcements==

@@ Line 43: / Line 43: @@
 **Updates most frequently
 **Liable to have the most bugs!
 ==Update Announcements==
@@ Line 58: / Line 60: @@
 '''Of course, always make sure to read and follow all instructions provided!''' This helps ensure that you update your site successfully and without incident!
-== See Also ==
+==See Also==
-* [[Tutorial: Introduction To Git]]
+*[[Tutorial: Introduction To Git]]
-* [[Tutorial: Installing Extensions]]
+*[[Tutorial: Installing Extensions]]
-* [[Contributing to Lorekeeper]]
+*[[Contributing to Lorekeeper]]
 [[Category:Documentation]]

@@ Line 1: / Line 1: @@
 Lorekeeper is continuously undergoing new development-- bugs being fixed, new features being worked on and added. When ready, these updates make their way to the [https://github.com/corowne/lorekeeper GitHub repository] by being merged into one of its branches, where they become available to you to update your own site with! However, for ease of development, greater consistency and stability in releases, and general organization, Lorekeeper is split into different branches. This may make it difficult to tell at first glance which branch you should update your site with; however, this can also help ensure you get the right updates.
-If you're not familiar with git, consider reading [[Tutorial: Introduction To Git]] first! This article assumes a basic knowledge of git.
+If you're not familiar with git, consider reading [[Tutorial: Introduction To Git]] first! This article assumes a basic knowledge of git. Also see [[Tutorial: Installing Extensions]] as the process of pulling, etc. updates themselves, managing any merge conflicts, and so on also applies here!
 If you yourself are interested in contributing to Lorekeeper, meanwhile, please read [[Contributing to Lorekeeper]]! It covers similar material but focuses on the development side of the material instead.
@@ Line 15: / Line 15: @@
 There are also three different ''types'' of branches. Branches of these types are temporary, and used primarily to keep code organized before it is merged into another branch. These types are:
-* Release branches
+*Release branches
-** These follow the naming scheme <code>release/UPCOMING-VERSION-HERE</code>.
+**These follow the naming scheme <code>release/UPCOMING-VERSION-HERE</code>.
-** These contain a stable version of an upcoming release-- again, this means no new features are being added!-- that is in testing so that bugs can be fixed before it ''becomes'' the current release.
+**These contain a stable version of an upcoming release-- again, this means no new features are being added!-- that is in testing so that bugs can be fixed before it ''becomes'' the current release.
-** '''<u>If a release branch exists, it's ok to pull</u>!''' In fact, it's helpful to do so if you're willing to report bugs, as catching and reporting them helps get them fixed-- and that helps ensure the upcoming release behaves as intended!
+**'''<u>If a release branch exists, it's ok to pull</u>!''' In fact, it's helpful to do so if you're willing to report bugs, as catching and reporting them helps get them fixed-- and that helps ensure the upcoming release behaves as intended!
-* Feature branches
+*Feature branches
-** These follow the naming scheme <code>feature/FEATURE-NAME-HERE</code>.
+**These follow the naming scheme <code>feature/FEATURE-NAME-HERE</code>.
-** These contain new features or bugfixes. These are made by contributors so as to keep proposed changes to Lorekeeper isolated so that they can be reviewed and, if/when they are approved, merged into another branch.
+**These contain new features or bugfixes. These are made by contributors so as to keep proposed changes to Lorekeeper isolated so that they can be reviewed and, if/when they are approved, merged into another branch.
-** '''<u>Do not pull these</u>!''' There is no guarantee that the code in them is ready for use and you are liable to break your site if you merge their contents into your site prematurely.
+**'''<u>Do not pull these</u>!''' There is no guarantee that the code in them is ready for use and you are liable to break your site if you merge their contents into your site prematurely.
-* Hotfix branches
+*Hotfix branches
-** These follow the naming scheme <code>hotfix/HOTFIX-NAME-HERE</code>.
+**These follow the naming scheme <code>hotfix/HOTFIX-NAME-HERE</code>.
-** These contain emergency bugfixes, e.g. fixes for critical issues or security vulnerabilities.
+**These contain emergency bugfixes, e.g. fixes for critical issues or security vulnerabilities.
-** '''<u>Do not pull these</u>!''' There is no guarantee that the code in them is ready for use and you are liable to break your site if you merge their contents into your site prematurely. They will be merged into <u>master</u> if/when they are approved.
+**'''<u>Do not pull these</u>!''' There is no guarantee that the code in them is ready for use and you are liable to break your site if you merge their contents into your site prematurely. They will be merged into <u>master</u> if/when they are approved.
-=== Which branch do I pull? ===
+===Which branch do I pull?===
 The answer to this question depends on whether you really need the latest features and/or how willing you're willing to handle potential bugs/bug reports, as well as how often you want to update your site. In summary:
-* <u>master</u>
+*<u>master</u>
-** Most stable
+**Most stable
-** Updates least frequently
+**Updates least frequently
-** Ideally, has the least bugs!
+**Ideally, has the least bugs!
-* (If one exists) the current release branch
+*(If one exists) the current release branch
-** Stable
+**Stable
-** Release branches occur infrequently, and update with bugfixes as they are contributed
+**Release branches occur infrequently, and update with bugfixes as they are contributed
-** Has a variable but diminishing number of bugs, generally
+**Has a variable but diminishing number of bugs, generally
-* <u>develop</u>
+*<u>develop</u>
-** Least stable
+**Least stable
-** Updates most frequently
+**Updates most frequently
-** Liable to have the most bugs!
+**Liable to have the most bugs!
-== Update Announcements ==
+==Update Announcements==
 Each Sunday-- assuming there are updates to report-- an announcement of changes made over the course of the week is posted to the Announcements channel of the [https://discord.gg/U4JZfsu Lorekeeper discord server].
 These announcements are broken down by branch (if multiple branches have been updated) and then broken down into three types of change:
-* New features (New)
+*New features (New)
-* Miscellaneous changes (Misc)
+*Miscellaneous changes (Misc)
-** These tend to be smaller tweaks that aren't new features in themselves nor bugfixes, but are nonetheless improvements!
+**These tend to be smaller tweaks that aren't new features in themselves nor bugfixes, but are nonetheless improvements!
-* Bugfixes (Bugs Fixed)
+*Bugfixes (Bugs Fixed)
 Additionally, any commands that must be run or other actions relating to updating are listed alongside the updates (for each branch, if there are multiple). If an announcement does not specify the branch updated, assume it's <u>develop</u>; it's this branch that sees the most/most frequent updates, as it can potentially be updated continuously.
 '''Of course, always make sure to read and follow all instructions provided!''' This helps ensure that you update your site successfully and without incident!
 [[Category:Documentation]]

@@ Line 3: / Line 3: @@
 If you're not familiar with git, consider reading [[Tutorial: Introduction To Git]] first! This article assumes a basic knowledge of git.
-If you yourself are interested in contributing to Lorekeeper, meanwhile, please read [[Contributing to Lorekeeper]]! It covers similar material but focuses on the development side of things instead.
+If you yourself are interested in contributing to Lorekeeper, meanwhile, please read [[Contributing to Lorekeeper]]! It covers similar material but focuses on the development side of the material instead.
 ==Branches & You==
 The core Lorekeeper repository, or repo, has several different branches corresponding to different kinds and stages of development. There are two that are always present:
-* <u>master</u>, which always has the latest '''stable release''' of Lorekeeper.
+*<u>master</u>, which always has the latest '''stable release''' of Lorekeeper. You can always pull this!
-* <u>develop</u>, which always has the latest ''updates'', but is consequently the least stable.
+*<u>develop</u>, which always has the latest '''updates and new features''', but this means it's the '''least stable'''. You can always pull this, but be aware that changes will be more frequent and bugs more likely!
-<br />
+"Stable", here, means that '''no new features are being added'''. Any change in the code in <u>master</u>, for instance, comes from either a new release or hotfix (which are only for critical issues!). This also tends to mean fewer bugs, as ideally most are caught and fixed before a a new version is released, and the lack of change means new bugs don't occur. Conversely, <u>develop</u> is the exact opposite: it always has the latest features, updates, etc.! Of course, this means that it always has the latest bugs. Similarly, new releases-- or updates to <u>master</u>-- happen relatively infrequently, while <u>develop</u> may be updated and added to at any time!
 [[Category:Documentation]]

@@ Line 1: / Line 1: @@
 Lorekeeper is continuously undergoing new development-- bugs being fixed, new features being worked on and added. When ready, these updates make their way to the [https://github.com/corowne/lorekeeper GitHub repository] by being merged into one of its branches, where they become available to you to update your own site with! However, for ease of development, greater consistency and stability in releases, and general organization, Lorekeeper is split into different branches. This may make it difficult to tell at first glance which branch you should update your site with; however, this can also help ensure you get the right updates.
-If you're not familiar with git, consider reading [[Tutorial: Introduction To Git]] first! This guide assumes a basic knowledge of git.
+If you're not familiar with git, consider reading [[Tutorial: Introduction To Git]] first! This article assumes a basic knowledge of git.
 If you yourself are interested in contributing to Lorekeeper, meanwhile, please read [[Contributing to Lorekeeper]]! It covers similar material but focuses on the development side of things instead.
-== Branches & You ==
+==Branches & You==
-Lorekeeper has several different branches
+The core Lorekeeper repository, or repo, has several different branches corresponding to different kinds and stages of development. There are two that are always present:
 [[Category:Documentation]]

← Older revision	Revision as of 23:09, 8 May 2021
(No difference)

← Older revision		Revision as of 21:39, 8 May 2021
Line 1:		Line 1:
−	~~<blockquote><~~/~~blockquote>~~	+	Lorekeeper is continuously undergoing new development-- bugs being fixed, new features being worked on and added. When ready, these updates make their way to the [https://github.com/corowne/lorekeeper GitHub repository] by being merged into one of its branches, where they become available to you to update your own site with! However, for ease of development, greater consistency and stability in releases, and general organization, Lorekeeper is split into different branches. This may make it difficult to tell at first glance which branch you should update your site with; however, this can also help ensure you get the right updates.
		+
		+	If you're not familiar with git, consider reading [[Tutorial: Introduction To Git]] first! This guide assumes a basic knowledge of git.
		+
		+	If you yourself are interested in contributing to Lorekeeper, meanwhile, please read [[Contributing to Lorekeeper]]! It covers similar material but focuses on the development side of things instead.
		+
		+	== Branches & You ==
		+	Lorekeeper has several different branches
		+	[[Category:Documentation]]