Skip to content
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.

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

Coding standards #2

Merged
merged 3 commits into from
Mar 30, 2020
Merged

Coding standards #2

merged 3 commits into from
Mar 30, 2020

Conversation

hugosolar
Copy link
Contributor

Description

This commit adds code sniff scripts to test and fix file formatting following the WordPress code Standards.

  • Add composer file
  • Add sniff scripts and instructions
  • Fix format options and file naming conventions following the Wordpress Code Standards
  • Add inline documentation following PHP Documentation Standards
  • Add contribute instructions
  • Add assets from Vocabulary (that should happen in the past commit but I missed it)

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the master branch of the repository.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@hugosolar hugosolar self-assigned this Mar 30, 2020
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

I'm weak at reviewing PHP, but it's obvious there's a lot of good work here!

I recommend the following CalVer version number format: YYYY.0M.Micro (Micro is not zero padded, see https://calver.org/). Version number would be: 2020.04.1.

Badge: CalVer Format: YYYY.0M.Micro

I also think you should link to CONTRIBUTE.md form the README.

.editorconfig Outdated Show resolved Hide resolved
.eslintignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
assets/js/script.js Outdated Show resolved Hide resolved
composer.json Show resolved Hide resolved
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

very good

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.

None yet

2 participants