From 75ee8cf4ed8686aa6267bfd0a7aa71b7ce717043 Mon Sep 17 00:00:00 2001 From: DumbergerL Date: Thu, 1 Aug 2024 09:21:58 +0200 Subject: [PATCH] docs(pull-request): add pr template --- .github/pull_request_template.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..792d4ae7 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,27 @@ +## Description + + + + +## Checklist + + + +### Documentation + +- [ ] Documentation is generated (if updated) (`composer docs-generator`) +- [ ] Pull request is added to CHANGELOG.md + +### Coding Style +- [ ] Request classes + - [ ] follow the existing [naming conventions](https://github.com/5pm-HDH/churchtools-api/blob/master/docs/out/Requests.md) (plural for builders, singular for objects) +- [ ] Model classes + - [ ] have default values for properties and protected visibility + - [ ] have getters and setters for properties +- [ ] methods with return type "array" have PHPDoc annotation with class if applicable (e.q.: `/** @return Group[] */`) +- [ ] CodingStyle enforcement is executed (`composer php-cs-fixer`) + +### Test + +- [ ] Integration test is added (if necessary) +- [ ] Unit test is created (if necessary)