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

Simplify composer installation instructions #200

Closed
wants to merge 1 commit into from
Closed

Simplify composer installation instructions #200

wants to merge 1 commit into from

Conversation

guiwoda
Copy link

@guiwoda guiwoda commented Oct 31, 2016

You shouldn't document how to use composer in this library.
Assume composer knowledge, and maybe add a link to its docs if you feel instructions aren't clear enough.

Check any other php library out there for conventions on composer docs.

Previous docs were too verbose and people with knowledge of composer would have to dig deep to find the package name (or end up looking for it in your composer.json instead of the README file.)

You shouldn't document how to use composer in this library. 
Assume composer knowledge, and maybe add a link to its docs if you feel instructions aren't clear enough.

Check [any](https://github.com/thephpleague/flysystem) [other](https://github.com/laravel/socialite) [php](https://github.com/zendframework/zend-diactoros/blob/master/doc/book/install.md) [library](https://symfony.com/doc/current/components/using_components.html) out there for conventions on composer docs.

Previous docs were too verbose and people with knowledge of composer would have to dig deep to find the package name (or end up looking for it in your `composer.json` instead of the README file.)
@jsteemann
Copy link
Contributor

Thanks for providing this patch!

I am happy to accept the patch, but for legal reasons we need you to fill out and sign our Contributor License Agreement (CLA). You can scan and email the CLA PDF file to cla@arangodb.com or send it via fax to +49-221-2722999-88.
Sorry for the inconvenience, but once the agreement is there the PR can be merged.

@frankmayer
Copy link
Contributor

Hi @guiwoda. Thanks for this PR.
Can we expect a signed CLA from you in order to be able to merge this PR or should I go ahead and make the necessary changes in a separate commit?

@guiwoda
Copy link
Author

guiwoda commented Feb 10, 2017 via email

frankmayer added a commit that referenced this pull request Feb 10, 2017
@frankmayer
Copy link
Contributor

This was implemented and further changed in a separate commit.
Thank you for your effort, @guiwoda

@frankmayer frankmayer closed this Feb 11, 2017
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.

3 participants