Contributing

Developing and testing coderedcms

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.

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.

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.

Building pip 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 and publish the documentation run:

cd docs/
make clean
make html

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 pypi:

twine upload dist/*

Finally build and update docs:

cd docs/
make clean
make html

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 symlink 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.