[Documentation] Add naming conventions to contributing section #14196
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GSadee
added
the
Documentation
lchrusciel
approved these changes
Aug 5, 2022
| * Suffix PHPSpec classes with `Spec`, | ||
| * Suffix PHPUnit tests with `Test`, | ||
| * Prefix Twig templates that are just partial blocks with `_`, | ||
| * Use fully qualified class name (FQCN) of an interface as a service name of newly created service or FQCN of class |
There was a problem hiding this comment.
Suggested change
| * Use fully qualified class name (FQCN) of an interface as a service name of newly created service or FQCN of class | |
| * Use fully qualified class name (FQCN) of an interface as a service name of newly created service or FQCN of class |
| * Suffix PHPUnit tests with `Test`, | ||
| * Prefix Twig templates that are just partial blocks with `_`, | ||
| * Use fully qualified class name (FQCN) of an interface as a service name of newly created service or FQCN of class | ||
| if there are multiple implementations of a given interface unless it is inconsistent with the current scope of Sylius. |
There was a problem hiding this comment.
Suggested change
| if there are multiple implementations of a given interface unless it is inconsistent with the current scope of Sylius. | |
| if there are multiple implementations of a given interface unless it is inconsistent with the current scope of Sylius. |
Zales0123
approved these changes
Aug 5, 2022
| * Suffix exceptions with `Exception`, | ||
| * Suffix PHPSpec classes with `Spec`, | ||
| * Suffix PHPUnit tests with `Test`, | ||
| * Prefix Twig templates that are just partial blocks with `_`, |
There was a problem hiding this comment.
Suggested change
| * Prefix Twig templates that are just partial blocks with `_`, | |
| * Prefix Twig templates that are partial blocks with `_`, |
| * Suffix PHPSpec classes with `Spec`, | ||
| * Suffix PHPUnit tests with `Test`, | ||
| * Prefix Twig templates that are just partial blocks with `_`, | ||
| * Use fully qualified class name (FQCN) of an interface as a service name of newly created service or FQCN of class |
There was a problem hiding this comment.
Suggested change
| * Use fully qualified class name (FQCN) of an interface as a service name of newly created service or FQCN of class | |
| * Use fully qualified class name (FQCN) of an interface as a service name of newly created service or FQCN of class |
| * Suffix PHPUnit tests with `Test`, | ||
| * Prefix Twig templates that are just partial blocks with `_`, | ||
| * Use fully qualified class name (FQCN) of an interface as a service name of newly created service or FQCN of class | ||
| if there are multiple implementations of a given interface unless it is inconsistent with the current scope of Sylius. |
There was a problem hiding this comment.
Suggested change
| if there are multiple implementations of a given interface unless it is inconsistent with the current scope of Sylius. | |
| if there are multiple implementations of a given interface unless it is inconsistent with the current scope of Sylius. |
lchrusciel
added a commit
that referenced
this pull request
Aug 9, 2022
…adee) This PR was merged into the 1.11 branch. Discussion ---------- | Q | A | |-----------------|--------------------------------------------------------------| | Branch? | 1.11| | Bug fix? | yes | | New feature? | no | | BC breaks? | no | | Deprecations? | no| | Related tickets | fixes #14196 | | License | MIT | <!-- - Bug fixes must be submitted against the 1.11 branch - Features and deprecations must be submitted against the 1.12 branch - Make sure that the correct base branch is set To be sure you are not breaking any Backward Compatibilities, check the documentation: https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html --> Commits ------- d0c022a [Documentation] Minor fixes to naming conventions page
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I would like to initiate a new chapter in our docs, in the
Contributingsection. Definitely, there is a need for some iterations over it, especially that there is probably many more conventions to write down but I believe that it is a good start 😃