Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (41 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

53 lines (41 loc) · 2.71 KB

Contributing

We maintain tags on our issues to make it easy to find ones that might suit newcomers to the project. The Low-hanging fruit tag is a good place to start if you're unfamiliar with the project.

Note

TLDR: The project is currently undergoing an overhaul behind the scenes with the goal of removing the need to use Django to serve pages. Check that your changes are still relevant with that in mind!

CCBV runs as a Django site, pulling data from a database. This made it very fast to get up and running, and easy to maintain for the Django-using developers, but it has been a thorn in the side of the project for years. The dataset is entirely fixed. Any changes to Django's generic class based views (GCBVs) only happen when Django makes a new release. We do not need to dynamically construct templates from the data on every request. We can write out some HTML and never touch it again (unless we feel like changing the site's styles!) The inspection code is tightly coupled to Django's GCBVs. There have been sites for other Django-specific class hierarchies using forks of CCBV for years. Other class hierarchies exist in Python. Work has been ongoing to reduce the coupling of the site to Django, with the goal of eventually completely removing it. This will help both this project and any related ones to more quickly update after Django or library releases, and also open up opportunities for other projects to grow.

Installation

Set up a virtualenv and run:

make build

This will install the requirements, collect static files, migrate the database, and finally load all the existing fixtures into your database.

Updating requirements

Add a dependency with:

uv add [--dev] <dependency>

Remove a dependency with:

uv remove [--dev] <dependency>

Update a single dependency with:

uv add [--dev] --upgrade-package <dependency>

Add data for new versions of Django

  1. Update Django with uv add --upgrade-package django<N, replacing N with the version after the one you are updating to
  2. Update the project's code to run under the target version of Django, as necessary;
  3. Use uv run manage.py populate_cbv to introspect the running Django and populate the required objects in the database;
  4. Use uv run manage.py fetch_docs_urls to update the records in the database with the latest links to the Django documentation;
  5. Export the new Django version into a fixture with: uv run manage.py cbv_dumpversion x.xx > cbv/fixtures/x.xx.json;

Testing

Run make test to run the full test suite with coverage.