Skip to content

Small list of improvements #6

Description

@sagikazarmark

I spent some time with the boilerplate repo, here is a small list of changes I suggest:

  • Line length restriction applies to PSR2 coding standard, but not markdown files. I think it is confusing that the lines are broken after hitting 80 characters. The IDE will handle that. In general: line length restriction does not make sense in continuous text.
  • @ddeboer you mentioned that you would like to keep instructions simple.

Open a command console

While this is simple, I think it is not necessary. The longest paragraph in the readme is the installation instruction part which is weird to me. I also think that the 'Issues and feature requests' should probably go into the Contribution guide.

???

What is this email address? Also, while github automatically transforms it into a link, I would rather add a formal MD anchor here with a mailto: link.

  • portphp/something also feels weird to me. Port Something is much more attractive IMO. 😉
  • I am missing a link to the packagist site of the package. I suggested a downloads badge earlier. Actually, I don't mind, but I think a link to that page is useful.
  • I would add PSR2 checking to scrutinizer:
tools:
  php_code_sniffer:
    config:
      standard: "PSR2"
  • In markdown files it increases the readability (in IDE) if there are empty lines before each headline.
  • I think the support part in the composer config file is not necessary. Everything (except the docs link) is automatically guessed by packagist.

I didn't open a PR as these things depend on personal preference as well. So take them into practice if you wish.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions