@@ -7,7 +7,7 @@ Developing Wagtail CRX
7
7
8
8
To create a test project locally:
9
9
10
- #. Clone the code from https://github.com/coderedcorp/coderedcms (dev branch).
10
+ #. Clone the code from https://github.com/coderedcorp/coderedcms (main branch).
11
11
#. Run ``pip install -r requirements-dev.txt `` from the root coderedcms
12
12
directory. This will install development tools, and also make the install
13
13
editable, which is relevant when running ``makemigrations `` in test project
@@ -38,22 +38,23 @@ Each production project that uses coderedcms should specify the appropriate
38
38
version in its requirements.txt to prevent breakage.
39
39
40
40
.. 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.
44
45
45
46
46
47
Branching Strategy
47
48
------------------
48
49
49
50
Primary 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.
51
52
52
- The ``dev `` branch is the primary working branch, representing the development
53
+ The ``main `` branch is the primary working branch, representing the development
53
54
version of coderedcms.
54
55
55
56
Releases 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 ``
57
58
(if applicable) and then merged or cherry-picked into the respective release
58
59
branch.
59
60
@@ -112,7 +113,7 @@ license header comment states copyright, ownership, license, and also provides c
112
113
/*!
113
114
Wagtail CRX (https://www.coderedcorp.com/cms/)
114
115
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
116
117
@license magnet:?xt=urn:btih:c80d50af7d3db9be66a4d0a86db0286e4fd33292&dn=bsd-3-clause.txt BSD-3-Clause
117
118
*/
118
119
@@ -155,8 +156,8 @@ code coverage percentage in the console:
155
156
Detailed test coverage reports are now available by opening ``htmlcov/index.html ``
156
157
in your browser (which is ignored by version control).
157
158
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:
160
161
161
162
.. code-block :: console
162
163
@@ -240,10 +241,10 @@ request process to ensure quality.**
240
241
Merging Pull Requests
241
242
---------------------
242
243
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:
244
245
245
246
* Unit tests pass.
246
- * Code coverage is not lower than dev branch.
247
+ * Code coverage is not lower than main branch.
247
248
* Documentation builds, and the PR provides documentation (release notes at a
248
249
minimum).
249
250
* 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:
255
256
In the event that the pull request needs more work that the author is unable to
256
257
provide, the following process should be followed:
257
258
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
259
260
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 .
261
262
* 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
263
264
sure to credit the original author(s) by adding their names to the bottom of
264
265
the commit message as so (see
265
266
`GitHub documentation <https://help.github.com/en/articles/creating-a-commit-with-multiple-authors >`_):
0 commit comments