PR Template

.github/pull_request_template.md

@@ -0,0 +1,25 @@
+**Checklist**:
+
+1. Code
+   - [ ] Finished development
+   - [ ] Finished unit tests (98% coverage)
+   - [ ] Added functional tests
+
+2. Database
+   - [ ] Created database migrations
+   - [ ] Updated Hasura metadata
+   - [ ] Recreated database graph (`make graph`)
+
+3. Verification
+   - [ ] Checked feature manually in browser/Postman
+   - [ ] Formatted code (`make format`)
+   - [ ] Checked code locally (`make lint test`)
+
+4. Documentation
+   - [ ] Connected PR to card on Trello
+   - [ ] Updated `README.md`
+   - [ ] Updated `CHANGELOG.md`
+   - [ ] Updated swagger (`make openapi`)
+
+5. Other
+   - [ ] Updated messages file (`make messages`) and added missing translations

Makefile

@@ -85,7 +85,7 @@ lint: lint-check lint-black lint-isort lint-pycodestyle lint-bandit lint-mypy li
 
 # General
 
-prcheck: install-dev format lint test-cov graph messages
+prcheck: install-dev format lint test-cov graph messages openapi
 
 # Docker
 
@@ -95,5 +95,8 @@ graph:
 messages:
 	docker-compose exec -T web django-admin makemessages -l pl
 
+openapi:
+	docker-compose exec -T web django-admin generateschema --file=docs/swagger.yaml
+
 django:
 	docker-compose exec web django-admin $(cmd)

README.md

@@ -74,10 +74,11 @@ Uses the default Django development server.
    1. Docker
       - graph - create model graph
       - messages - updates translation file
+      - openapi - updates swagger file
       - django - run django admin command (syntax: `make django cmd='migrate'`)
 
    For example, before creating a pull requests make sure you ran locally:
-   `make install-dev format lint test-cov graph messages`
+   `make install-dev format lint test-cov graph messages openapi`
    (And check if there are no missing transactions) or simply:
    `make prcheck`.