@@ -7,7 +7,7 @@ Developing Wagtail CRX
77
88To create a test project locally:
99
10- #. Clone the code from https://github.com/coderedcorp/coderedcms (dev branch).
10+ #. Clone the code from https://github.com/coderedcorp/coderedcms (main branch).
1111#. Run ``pip install -r requirements-dev.txt `` from the root coderedcms
1212 directory. This will install development tools, and also make the install
1313 editable, which is relevant when running ``makemigrations `` in test project
@@ -38,22 +38,23 @@ Each production project that uses coderedcms should specify the appropriate
3838version in its requirements.txt to prevent breakage.
3939
4040.. note ::
41- When testing existing projects with coderedcms installed from a development
42- branch, be sure to use a disposable database, as it is likely that the
43- migrations will not be the same migrations that get released.
41+
42+ When testing existing projects with coderedcms installed from a development
43+ branch, be sure to use a disposable database, as it is likely that the
44+ migrations will not be the same migrations that get released.
4445
4546
4647Branching Strategy
4748------------------
4849
4950Primary development takes place in individual branches for each feature or bug.
50- Changes are then made as a pull request against the ``dev `` branch.
51+ Changes are then made as a pull request against the ``main `` branch.
5152
52- The ``dev `` branch is the primary working branch, representing the development
53+ The ``main `` branch is the primary working branch, representing the development
5354version of coderedcms.
5455
5556Releases are maintained in ``release/X.Y `` branches, where X is the Major
56- version and Y is the Minor version. Maintenance patches are applied in ``dev ``
57+ version and Y is the Minor version. Maintenance patches are applied in ``main ``
5758(if applicable) and then merged or cherry-picked into the respective release
5859branch.
5960
@@ -112,7 +113,7 @@ license header comment states copyright, ownership, license, and also provides c
112113 /*!
113114 Wagtail CRX (https://www.coderedcorp.com/cms/)
114115 Copyright 2018-2021 CodeRed LLC
115- License: https://github.com/coderedcorp/coderedcms/blob/dev /LICENSE
116+ License: https://github.com/coderedcorp/coderedcms/blob/main /LICENSE
116117 @license magnet:?xt=urn:btih:c80d50af7d3db9be66a4d0a86db0286e4fd33292&dn=bsd-3-clause.txt BSD-3-Clause
117118 */
118119
@@ -155,8 +156,8 @@ code coverage percentage in the console:
155156 Detailed test coverage reports are now available by opening ``htmlcov/index.html ``
156157in your browser (which is ignored by version control).
157158
158- To compare your current code coverage against the code coverage of the dev
159- branch (based on latest Azure Pipeline build from dev ) run:
159+ To compare your current code coverage against the code coverage of the main
160+ branch (based on latest Azure Pipeline build from main ) run:
160161
161162.. code-block :: console
162163
@@ -240,10 +241,10 @@ request process to ensure quality.**
240241Merging Pull Requests
241242---------------------
242243
243- Follow these guidelines to merge a pull request into the dev branch:
244+ Follow these guidelines to merge a pull request into the main branch:
244245
245246* Unit tests pass.
246- * Code coverage is not lower than dev branch.
247+ * Code coverage is not lower than main branch.
247248* Documentation builds, and the PR provides documentation (release notes at a
248249 minimum).
249250* If there is a related issue, the issue is referenced and/or closed (if
@@ -255,11 +256,11 @@ Follow these guidelines to merge a pull request into the dev branch:
255256In the event that the pull request needs more work that the author is unable to
256257provide, the following process should be followed:
257258
258- * Create a new branch from dev in the form of ``merge/pr-123 `` where 123 is
259+ * Create a new branch from main in the form of ``merge/pr-123 `` where 123 is
259260 the original pull request number.
260- * Edit the pull request to merge into the new branch instead of dev .
261+ * Edit the pull request to merge into the new branch instead of main .
261262* Make the necessary changes and submit for review using the normal process.
262- * When merging this branch into dev , follow the same process above, but be
263+ * When merging this branch into main , follow the same process above, but be
263264 sure to credit the original author(s) by adding their names to the bottom of
264265 the commit message as so (see
265266 `GitHub documentation <https://help.github.com/en/articles/creating-a-commit-with-multiple-authors >`_):
0 commit comments