Skip to content
This repository was archived by the owner on Jan 15, 2021. It is now read-only.

Make install instructions more clear. #137

Closed
wants to merge 1 commit into from
Closed

Make install instructions more clear. #137

wants to merge 1 commit into from

Conversation

driesvints
Copy link

Make it more clear how to install this in a project which uses Composer. Apparently it's enough to have this package in your dependencies but the install instructions from the readme weren't clear on this.

https://symfony.com/doc/current/setup.html#checking-for-security-vulnerabilities

Make it more clear how to install this in a project which uses Composer. Apparently it's enough to have this package in your dependencies but the install instructions from the readme weren't clear on this.

https://symfony.com/doc/current/setup.html#checking-for-security-vulnerabilities
@@ -23,6 +23,8 @@ Integration
The checker uses the Symfony Console component; so, you can easily integrate
the checker into your own project:

* by requiring it with Composer: `composer require ensiolabs/security-checker --dev`: https://symfony.com/doc/current/setup.html#checking-for-security-vulnerabilities
Copy link
Member

Choose a reason for hiding this comment

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

I would not recommend it as your project deps can interfere with the checker ones.

Copy link
Author

Choose a reason for hiding this comment

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

But it's in Symfony's own docs? Does it need to be removed from those docs then if you don't recommend it?

Copy link
Member

Choose a reason for hiding this comment

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

It needs to be removed everywhere. It's the default value, so there is no need to be explicit here.

Copy link
Author

Choose a reason for hiding this comment

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

Okay I'll send in a PR to remove it from the Symfony docs 👍

@driesvints driesvints closed this Nov 26, 2018
@driesvints driesvints deleted the patch-1 branch November 26, 2018 17:16
xabbuh added a commit to symfony/symfony-docs that referenced this pull request Nov 30, 2018
This PR was merged into the 4.1 branch.

Discussion
----------

Don't recommend requiring with Composer

See discussion here: sensiolabs/security-checker#137 (review)

Commits
-------

801645f Don't recommend requiring with Composer
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants