Skip to content

Commit 6833662

Browse files
committed
Rewrite the README to be clear and succinct
This modernises the project's README to match the current state of the project (ie dropping tools we should look at), tidies up the prose to be more succinct, and splits out contribution docs to CONTRIBUTING.md. The contributor docs have been streamlined to point to the `make` commands where possible. I've also added a section from #245 on where the project is going. It's a long piece of work so my hope is this sets expectations without making the maintainers feel bad when folks raise a PR for defunct or soon-to-be-removed code paths.
1 parent 1ed9580 commit 6833662

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The [Low-hanging fruit tag](https://github.com/classy-python/ccbv/issues?q=is%3A
99
> CCBV runs as a Django site, pulling data from a database.
1010
> 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.
1111
> The dataset is entirely fixed.
12-
> Any changes to the GCBVs only happen in a release of Django.
12+
> Any changes to Django's generic class based views (GCBVs) only happen when Django makes a new release.
1313
> We do not need to dynamically construct templates from the data on every request.
1414
> We can write out some HTML and never touch it again (unless we feel like changing the site's styles!)
1515
> The inspection code is tightly coupled to Django's GCBVs.
@@ -40,4 +40,3 @@ Run `make compile` and appropriate txt file will be updated.
4040

4141
## Testing
4242
Run `make test` to run the full test suite with coverage.
43-

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# [Classy Class Based Views](https://ccbv.co.uk)
22

33
Django's Generic class-based views provide a lot of common functionality to users.
4-
However, they are made up of up to nine, at the time of writing, parent classes or mixins.
4+
However, they are made up of up to twelve parent classes or mixins, at the time of writing.
55
Knowing what functionality comes from which parent class/mixin is a tricky proposition.
66

77
CCBV provides a breakdown of each view's inheritance hierarchy, methods, and attributes.

0 commit comments

Comments
 (0)