Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
drien authored Jan 22, 2024
1 parent 3f981ec commit 97c916a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ This is an opinionated template that brings together a number of other tools and

### Contributing

The goals of the template are that it remain:

- One-click to a running app
- "Available in any color, so long as it is black"
- Easy to maintain up-to-date dependencies
- Easy to understand the structure and layout

The intent of this template is to provide a starting point where things "just work" out of the box. Contributions should follow that as a guiding principle: if a change introduces something that requires extensive customization after running the boostrap script for it to work at all, it's probably not a great thing to include.

Secondary to that, the bootstrap script is intended to be a single path: it is not the intent to introduce an interactive or configurable process that produces a different result based on user choices, but instead produce one output that can be modified manually after the fact.

Dependencies *do not follow LTS releases*. The intent is that dependencies, including Djang itself, are up to date with the latest stable release wherever possible. If an important dependency becomes unmaintained or there are significant benefits to be had from an alternative, it should be replaced.

0 comments on commit 97c916a

Please sign in to comment.