diff options
author | 2018-09-18 22:23:49 +0200 | |
---|---|---|
committer | 2018-09-18 22:23:49 +0200 | |
commit | def48755cfb6edf0c25d321024e71bc471ebd75c (patch) | |
tree | ec78e004d279a5c57d384da4b7fec6f84c275e6b | |
parent | Fix up `HEALTHCHECK`. (diff) |
Update changelog & contributing guidelines, bump version.v0.3.0
-rw-r--r-- | CHANGELOG.md | 19 | ||||
-rw-r--r-- | CONTRIBUTING.md | 4 | ||||
-rw-r--r-- | setup.py | 2 |
3 files changed, 23 insertions, 2 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..22e6e2d3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + +## [0.3.0] - 2018-18-09 +### Added +- Do not recommend pushes to `master` in `CONTRIBUTING.md` +- Documentation about how to set up the site and Postgres up locally using Docker and `pip` +- Healthchecks for the `app` container +- Require 100% code coverage in `CONTRIBUTING.md` +- Require `CHANGELOG.md` updates in `CONTRIBUTING.md` +- The `psmgr` console script as a shortcut to `python manage.py` +- This file + +### Changed +- Improved build speed by not installing unneeded dependencies. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f36899ce..0a800335 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,9 +16,11 @@ contributions may be rejected on the basis of a contributor failing to follow th own merge request. If you do this, we suggest following these guidelines when interacting with their repository as well. 1. **Adhere to the prevailing code style**, which we enforce using [flake8](http://flake8.pycqa.org/en/latest/index.html). - * Keep the coverage at 100%. Your reason not to do so is not good enough. * Additionally, run `flake8` against your code before you push it. Your commit will be rejected by the build server if it fails to lint. + * Keep the coverage at 100%. Your reason not to do so is not good enough. + * No pushes to `master` without a really really good reason. If you're unsure, it is not good enough. + * Update the `CHANGELOG.md` file as necessary. Maintainers will tag releases as appropriate. 1. **Don't fight the framework**. Every framework has its flaws, but the frameworks we've picked out have been carefully chosen for their particular merits. If you can avoid it, please resist reimplementing swathes of framework logic - the work has already been done for you! @@ -8,7 +8,7 @@ setup( project_urls={ 'Source code': 'https://gitlab.com/python-discord/projects/site' }, - version='0.2.0', + version='0.3.0', packages=find_packages( exclude=('**/static',) ), |