Skip to content

Proposed change to guideline 4 to clarify use of build tools#86

Open
alanef wants to merge 3 commits intoWordPress:trunkfrom
alanef:trunk
Open

Proposed change to guideline 4 to clarify use of build tools#86
alanef wants to merge 3 commits intoWordPress:trunkfrom
alanef:trunk

Conversation

@alanef
Copy link
Copy Markdown

@alanef alanef commented Nov 12, 2023

Section 4 was probably composed before common use of build tools and now is contradictory,

Issues

  1. The title use (mostly) which is far from definitive
  2. Obscured code is definitively banned in paragraph 1 “ is not permitted in the directory”, no exception, yet blocks built in REACT have ‘obscured' compiled code
  3. Then there is an unrelated comment about build tools and source

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.

@davidperezgar
Copy link
Copy Markdown
Member

I agree with this PR.

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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"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?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have mode some wording that I think covers those concerns

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants