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

Small list of improvements #6

Open
sagikazarmark opened this issue Jun 7, 2015 · 2 comments
Open

Small list of improvements #6

sagikazarmark opened this issue Jun 7, 2015 · 2 comments

Comments

@sagikazarmark
Copy link

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.

@sagikazarmark
Copy link
Author

One more thing: "dev-master": "1.0.x-dev" The 'x' is not needed: "dev-master": "1.0-dev"

@ddeboer
Copy link
Member

ddeboer commented Jun 19, 2015

[email protected]

Fixed.

Port Something is much more attractive IMO.

Changed.

One more thing: "dev-master": "1.0.x-dev" The 'x' is not needed: "dev-master": "1.0-dev"

True, but it’s called 1.0.x-dev on Packagist, isn’t it? So I think it’s clear like this.

I also think that the 'Issues and feature requests' should probably go into the Contribution guide.

I like to have it on the repo’s front page.

The fixes still need to be applied to the separate repos.

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

No branches or pull requests

2 participants