Proposed change to guideline 4 to clarify use of build tools#86
Open
alanef wants to merge 3 commits intoWordPress:trunkfrom
Open
Proposed change to guideline 4 to clarify use of build tools#86alanef wants to merge 3 commits intoWordPress:trunkfrom
alanef wants to merge 3 commits intoWordPress:trunkfrom
Conversation
frantorres
reviewed
Nov 12, 2023
frantorres
reviewed
Nov 12, 2023
Member
|
I agree with this PR. |
frantorres
reviewed
Nov 12, 2023
guideline-04.md
Outdated
| We strongly recommend you document how any development tools are to be used. | ||
| We strongly recommend you document how any build tools are to be used. | ||
|
|
||
| Original source code must be human readable and not be deliberately obscured. |
There was a problem hiding this comment.
Would add some additional cases as we saw some people being so prolific that they are able to read and edit minified code.
As for example:
Original source code must be human readable and not be deliberately obscured, minified, omitting comments, using unclear naming conventions and/or making use of other techniques that make it difficult to read, understand and/or edit.
Author
There was a problem hiding this comment.
"omitting comments, using unclear naming conventions"
Isnt this a bit subjective? Especially comments. When is a comment in a the original source code omitted or just not written?
Author
There was a problem hiding this comment.
I have mode some wording that I think covers those concerns
This file contains hidden or 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
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.
Section 4 was probably composed before common use of build tools and now is contradictory,
Issues
For new plugin developers, this is confusing. The proposed wording clarifies original source and build code and also acknowledges that the (open) build tool configuration is also an important part of being able to modify original code.