Skip to content

Commit 7dd9a8c

Browse files
committed
refactor: Add note about duplication phpDoc
1 parent ce21798 commit 7dd9a8c

File tree

2 files changed

+4
-7
lines changed

2 files changed

+4
-7
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,17 @@ Each pull request should address a single issue and have a meaningful title.
55
- PR title must include the type (feat, fix, chore, docs, perf, refactor, style, test) of the commit per Conventional Commits specification. See https://www.conventionalcommits.org/en/v1.0.0/ for the discussion.
66
- Pull requests must be in English.
77
- If a pull request fixes an issue, reference the issue with a suitable keyword (e.g., Fixes <issue number>).
8+
- Your branch name and the target name should be different.
89
- All bug fixes should be sent to the __"develop"__ branch, this is where the next bug fix version will be developed.
9-
- PRs with any enhancement should be sent to the next minor version branch, e.g. __"4.5"__
10+
- PRs with any enhancement should be sent to the next minor version branch, e.g. __"4.7"__
1011
1112
-->
1213
**Description**
1314
Explain what you have changed, and why.
1415

1516
**Checklist:**
1617
- [ ] Securely signed commits
17-
- [ ] Component(s) with PHPDoc blocks, only if necessary or adds value
18+
- [ ] Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
1819
- [ ] Unit testing, with >80% coverage
1920
- [ ] User guide updated
2021
- [ ] Conforms to style guide

contributing/pull_request.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,7 @@ implementation comments to explain potentially confusing sections of
9696
code, and documentation comments before each public or protected
9797
class/interface/trait, method, and variable.
9898

99-
Do not add PHPDoc comments that are superficial, duplicated, or stating the obvious.
100-
101-
It is not recommended to reuse comments if the parent class or interface already contains a description of the child element.
102-
103-
You can re-add a comment in a child element if it has a more precise type - i.e change `int|string` to `string`.
99+
Do not add PHPDoc comments that are superficial, duplicated, or stating the obvious. It is not recommended to reuse comments if the parent class or interface already contains a description of the child element.
104100

105101
See the following for more information.
106102

0 commit comments

Comments
 (0)