Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alanef wants to merge 3 commits into
base: trunk
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8971ac
Proposed change to guideline 4 to clarify use of build tools
alanef Nov 12, 2023
52a11af
Adjust to review comments
alanef Nov 12, 2023
2e25a95
Adjust to add more about what original source is
alanef Nov 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions guideline-04.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
<h4>4. Code must be (mostly) human readable.</h4>
<h4>4. Original source code and build tools must be publicly available.</h4>

Obscuring code by hiding it with techniques or systems similar to <code>p,a,c,k,e,r</code>'s obfuscate feature, uglify's mangle, or unclear naming conventions such as <code>$z12sdf813d</code>, is not permitted in the directory. Making code non-human readable forces future developers to face an unnecessary hurdle, as well as being a common vector for hidden, malicious code.

We require developers to provide public, maintained access to their source code and any build tools in one of the following ways:
We require developers to provide public, maintained access to their original source code and any build tool configuration files and custom build tools in one of the following ways:

<ul>
<li>Include the source code in the deployed plugin</li>
<li>A link in the readme to the development location</li>
<li>Include the source code, any build tool configuration files and custom build tools (if any) in the deployed plugin</li>
<li>A link in the readme to the development location</li>
</ul>

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 the original edit of the code and not minified or otherwise altered after editing.
Original source code should be written so it is clearly understandable using sensible naming conventions and comments where appropriate
and not deliberately obscured or obfuscated.