Contributing

Developing CodeRed CMS

To create a test project locally:

  1. Clone the code from https://github.com/coderedcorp/coderedcms.

  2. Run pip install -e ./[dev] from the root coderedcms directory. The -e flag makes the install editable, which is relevant when running makemigrations in test project to actually generate the migration files in the coderedcms pip package. The [dev] installs extras such as sphinx for generating docs.

  3. Follow the steps in Installation. Use testproject for your project name to ensure it is ignored by git.

  4. When making model or block changes within coderedcms, run makemigrations coderedcms in the test project to generate the relevant migration files for the pip package. ALWAYS follow steps 4 and 5 in Installation with a fresh database before making migrations.

  5. When model or block changes affect the local test project (i.e. the “website” app), run makemigrations website in the test project to generate the relevant migration files locally. Apply and test the migrations. When satisfied, re-generate the 0001_initial.py migration in project_template/website/migrations/ as so:

    1. Create a new test project using coderedcms start testproject.

    2. Before running migrations, DELETE all migrations in testproject/website/migrations/.

    3. Run python manage.py makemigrations website. This should generate an 0001_initial.py migration.

    4. Replace project_template/website/migrations/0001_initial.py with your newly generated migration.

When making changes that are potentially destructive or backwards incompatible, increment the minor version number until coderedcms reaches a stable 1.0 release. Each production project that uses coderedcms should specify the appropriate version in its requirements.txt to prevent breakage.

Note

When testing existing projects with coderedcms installed from the master or development branches, be sure to use a disposable database, as it is likely that the migrations in master will not be the same migrations that get released.

A Note on Cross-Platform Support

CodeRed CMS works equally well on Windows, macOS, and Linux. When adding new features or new dependencies, ensure that these utilize proper cross-platform utilities in Python.

To ease local development of CodeRed CMS, we have many automation scripts using PowerShell Core because it provides high quality commercial support for Windows, macOS, and Linux. Throughout this contributing guide, you will encounter various PowerShell scripts which always provide the easiest and most definitive way of working on CodeRed CMS.

Our goal is that users of any platform can develop or host a CodeRed CMS website easily.

CSS Development

When CSS changes are needed for front-end code (not the wagtail admin), Sass should be used. Each block, page, snippet, or other component that requires styling should have a dedicated .scss file created beginning with an underscore in coderedcms/static/scss/. Then import the file in our main codered-front.scss file. Then build a human readable and minified version of CSS from the command prompt as so:

$ cd coderedcms/static/coderedcms/

// Build human readable CSS, and source map for nicer debugging.
$ pysassc -g -t expanded scss/codered-front.scss css/codered-front.css

// Build minified CSS.
$ pysassc -t compressed scss/codered-front.scss css/codered-front.min.css

Finally, copy the license header comment into codered-front.min.css (since pysassc does not have an argument to preserve comments while also using compressed output).

The generated CSS files must also be committed to version control whenever a sass file is changed, as they are distributed as part of our package.

JavaScript Development

All JavaScript should use codered-front.js as an entry point, meaning feature detection should happen in codered-front.js and then only load secondary scripts and CSS as needed. This ensures only one single small JavaScript file is required on page load, which reduces render-blocking resources and page load time.

All JavaScript files produced by CodeRed should contain a license header comment. This standard license header comment states copyright, ownership, license, and also provides compatibility for LibreJS.

/*
CodeRed CMS (https://www.coderedcorp.com/cms/)
Copyright 2018-2019 CodeRed LLC
License: https://github.com/coderedcorp/coderedcms/blob/master/LICENSE
@license magnet:?xt=urn:btih:c80d50af7d3db9be66a4d0a86db0286e4fd33292&dn=bsd-3-clause.txt BSD-3-Clause
*/

... script code here ...

/* @license-end */

Testing CodeRed CMS

To run the unit tests, run the following command. This will output a unit test report and code coverage report:

$ pytest coderedcms/ --ds=coderedcms.tests.settings --junitxml=junit/test-results.xml --cov=coderedcms --cov-report=xml --cov-report=html

Or more conveniently, run the PowerShell script, which will also print out the code coverage percentage in the console:

$ ./ci/run-tests.ps1

Detailed test coverage reports are now available by opening htmlcov/index.html in your browser (which is ignored by version control)

Adding New Tests

Test coverage at the moment is fairly minimal and it is highly recommended that new features and models include proper unit tests. Any testing infrastructure (i.e. implementations of abstract models and migrations) needed should be added to the tests app in your local copy of CodeRed CMS. The tests themselves should be in their relevant section in CodeRed CMS (i.e. tests for models in coderedcms.models.page_models should be located in coderedcms.models.tests.test_page_models).

For example, here is how you would add tests for a new abstract page type, CoderedCustomPage that would live in coderedcms/models/page_models.py:

  1. Navigate to coderedcms/tests/testapp/models.py

  2. Add the following import: from coderedcms.models.page_models import CoderedCustomPage

  3. Implement a concrete version of CoderedCustomPage, i.e. CustomPage(CoderedCustomPage).

  4. Run python manage.py makemigrations to make new testing migrations.

  5. Navigate to coderedcms/models/tests/test_page_models.py

  6. Add the following import: from coderedcms.models import CoderedCustomPage

  7. Add the following import: from coderedcms.tests.testapp.models import CustomPage

  8. Add the following to the bottom of the file:

    class CoderedCustomPageTestCase(AbstractPageTestCase, WagtailPageTests):
        model = CoderedCustomPage
    
  9. Add the following to the bottom of the file:

    class CustomPageTestCase(ConcreteBasicPageTestCase, WagtailPageTests):
        model = CustomPage
    
  10. Write any specific test cases that CoderedCustomPage and CustomPage may require.

Static Analysis

Flake8 is used to check for syntax and style errors. To analyze the entire codebase, run:

$ flake8 .

Alternatively, our continuous integration only analyzes the diff between your changes and master. To analyze just the diff of your current changes, run the PowerShell Core script:

$ ./ci/run-flake8.ps1

Contributor Guidelines

We are happy to accept pull requests from the community if it aligns with our vision for coderedcms. When creating a pull request, please make sure you include the following:

  • A description in the pull request of what this change does and how it works.

  • Reference to an issue if the change is related to one of the issues on our GitHub page.

  • Documentation updates in the docs/ directory describing your change.

  • Unit tests, or a description of how the change was manually tested.

Following submission of your pull request, a CodeRed member will review and test your change. All changes, even by CodeRed members, must go through a pull request process to ensure quality.

Merging Pull Requests

Follow these guidelines to merge a pull request into the master branch:

  • Unit tests pass.

  • Code coverage is not lower than master branch.

  • Documentation builds, and the PR provides documentation (release notes at a minimum).

  • If there is a related issue, the issue is referenced and/or closed (if applicable)

  • Finally, always make a squash merge with a single descriptive commit message. Avoid simply using the default commit message generated by GitHub if it is a summary of previous commits or is not descriptive of the change.

In the event that the pull request needs more work that the author is unable to provide, the following process should be followed:

  • Create a new branch from master in the form of merge/pr-123 where 123 is the original pull request number.

  • Edit the pull request to merge into the new branch instead of master.

  • Make the necessary changes and submit for review using the normal process.

  • When merging this branch into master, follow the same process above, but be sure to credit the original author(s) by adding their names to the bottom of the commit message as so (see GitHub documentation):

    Co-authored-by: name <name@example.com>
    Co-authored-by: another-name <another-name@example.com>
    

Building Python Packages

To build a publicly consumable pip package, run:

$ python setup.py sdist bdist_wheel

Building Documentation

For every code or feature change, be sure to update the docs in the repository. To build the documentation run the PowerShell script, which will also check for errors in the documentation:

$ ./ci/make-docs.ps1

Or manually using sphinx:

$ sphinx-build -M html docs/ docs/_build/ -W

Output will be in docs/_build/html/ directory.

Publishing a New Release

First checkout the code/branch for release.

Next build a pip package:

$ python setup.py sdist bdist_wheel

Then upload the pip package to the Python Package Index:

$ twine upload dist/*

Finally build and update docs:

$ ./ci/make-docs.ps1

If updating docs for an existing minor version release:

  1. Copy the contents of docs/_build/html/ to the CodeRed docs server under the existing version directory.

If this is a new major or minor version release:

  1. Create a new major.minor directory on the CodeRed docs server.

  2. Update the stable symbolic link to point to the new version directory.

  3. Add the new version to the versions.txt file on the docs server.

  4. Copy the contents of docs/_build/html/ to the CodeRed docs server under the new version directory.

Note that we do not release separate documentation versions for maintenance releases. Update the existing minor version docs with release notes and other changes.