Merge pull request #5790 from leplatrem/syseng-quality-standards

Implement some of the quality standards rules

.github/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued.
+
+Before doing so, here are a few guidelines:
+
+* You agree to license your contributions under the project [license](LICENSE).
+* Use pull-requests early so it's open for discussion, even if your
+  contribution isn't ready yet.
+* All pull requests should include tests, as they help us avoid regressions in
+  our code.
+* A pull-request adding functionality should also update the documentation
+  accordingly.

.github/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+This code and its associated production web page are included in the Mozilla’s web and services [bug bounty program](https://www.mozilla.org/en-US/security/web-bug-bounty/). If you find a security vulnerability, please submit it via the process outlined in the program and [FAQ pages](https://www.mozilla.org/en-US/security/bug-bounty/faq-webapp/). Further technical details about this application are available from the [Bug Bounty Onramp page](https://wiki.mozilla.org/Security/BugBountyOnramp/).
+
+Please submit all security-related bugs through Bugzilla using the [web security bug form](https://bugzilla.mozilla.org/form.web.bounty). Never submit security-related bugs through a Github Issue or by email.

.github/SUPPORT.md

@@ -0,0 +1,3 @@
+# Support
+
+See our [contact information](https://kitsune.readthedocs.io/en/latest/contactus.html#contact-us-chapter)!

Makefile

@@ -12,7 +12,7 @@ default: help
 
 help:
 	@echo "build         - build docker images for dev"
-	@echo "run           - docker-compose up the entire system for dev"
+	@echo "start         - docker-compose up the entire system for dev"
 	@echo ""
 	@echo "init          - initialize the database and install Node packages"
 	@echo "djshell       - start a Django Python shell (ipython)"
@@ -21,18 +21,17 @@ help:
 	@echo "runshell      - start a bash shell with ports bound so you can run the server"
 	@echo "clean         - remove all build, test, coverage and Python artifacts"
 	@echo "rebuild       - force a rebuild of the dev docker image"
+	@echo "format        - format source files"
 	@echo "lint          - run pre-commit hooks"
 	@echo "test          - run python tests"
 	@echo "test-js       - run js tests"
 	@echo "docs          - generate Sphinx HTML documentation"
 
 .env:
-	@if [ ! -f .env ]; then \
-		echo "Copying .env-dist to .env..."; \
-		cp .env-dist .env; \
-	fi
+	@echo "Copying .env-dist to .env...";
+	cp -n .env-dist .env;
 
-.docker-build:
+.docker-build: .env
 	${MAKE} build
 
 build:
@@ -41,8 +40,9 @@ build:
 
 rebuild: clean build
 
-run: .docker-build
+start: .docker-build
 	${DC} up web
+run: start
 
 init: .docker-build
 	${DC} run web bin/run-bootstrap.sh
@@ -76,6 +76,9 @@ clean:
 lint: .docker-build
 	${DC} run web pre-commit run --all-files
 
+format: .docker-build
+	${DC} run web black kitsune/
+
 test: .docker-build
 	${DC} run web ./bin/run-unit-tests.sh
 
@@ -86,4 +89,4 @@ docs: .docker-build
 	${DC} run web $(MAKE) -C docs/ clean
 	${DC} run web $(MAKE) -C docs/ html
 
-.PHONY: build rebuild run init shell runshell djshell clean lint test test-js docs
+.PHONY: build rebuild run init shell runshell djshell clean lint format test test-js docs

README.md

@@ -1,7 +1,10 @@
 # Kitsune
 
+![Status Sustain](https://img.shields.io/badge/Status-Sustain-green)
+
 Kitsune is the platform that powers [SuMo (support.mozilla.org)](https://support.mozilla.org)
 
+## Usage
 It is a [Django](http://www.djangoproject.com/) application. There is [documentation](https://kitsune.readthedocs.io/en/latest/) online.
 
 ## Deployment