From 58582a11310a5da2896df38ad57aaa46cd1cbef4 Mon Sep 17 00:00:00 2001 From: Mathieu Leplatre Date: Thu, 23 Nov 2023 13:10:03 +0100 Subject: [PATCH 1/5] Fix handling of .env --- Makefile | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index d3848dadd59..8c4e9c069bb 100644 --- a/Makefile +++ b/Makefile @@ -27,12 +27,10 @@ help: @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: From 497cd4bc6135d3706845bf39780d603a64a05167 Mon Sep 17 00:00:00 2001 From: Mathieu Leplatre Date: Thu, 23 Nov 2023 13:10:21 +0100 Subject: [PATCH 2/5] Use alias for make start --- Makefile | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 8c4e9c069bb..526ccdcef89 100644 --- a/Makefile +++ b/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)" @@ -39,8 +39,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 From 7800bdc32a32999779f4d5d3c4eadae5bd973352 Mon Sep 17 00:00:00 2001 From: Mathieu Leplatre Date: Thu, 23 Nov 2023 13:10:33 +0100 Subject: [PATCH 3/5] Add missing sections in README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9bbeac75b65..6a4e9020d6f 100644 --- a/README.md +++ b/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 From 3feeed99f29305453930918312e5f9299b3e5e5a Mon Sep 17 00:00:00 2001 From: Mathieu Leplatre Date: Thu, 23 Nov 2023 13:18:10 +0100 Subject: [PATCH 4/5] Add format target for Makefile --- Makefile | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 526ccdcef89..fb716c763e0 100644 --- a/Makefile +++ b/Makefile @@ -21,6 +21,7 @@ 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" @@ -75,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 @@ -85,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 From 1666a5b1aef8d15695ea553466627b76b98e308c Mon Sep 17 00:00:00 2001 From: Mathieu Leplatre Date: Thu, 23 Nov 2023 13:18:22 +0100 Subject: [PATCH 5/5] Add missing standard files --- .github/CONTRIBUTING.md | 13 +++++++++++++ .github/SECURITY.md | 5 +++++ .github/SUPPORT.md | 3 +++ 3 files changed, 21 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/SECURITY.md create mode 100644 .github/SUPPORT.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000000..dfb71055f20 --- /dev/null +++ b/.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. diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 00000000000..0e9b29d1f01 --- /dev/null +++ b/.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. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 00000000000..6a5e9bc8fc4 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,3 @@ +# Support + +See our [contact information](https://kitsune.readthedocs.io/en/latest/contactus.html#contact-us-chapter)!