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

vendor/ Directory Considerations #19

Closed
ramsey opened this issue Dec 30, 2016 · 9 comments
Closed

vendor/ Directory Considerations #19

ramsey opened this issue Dec 30, 2016 · 9 comments

Comments

@ramsey
Copy link

ramsey commented Dec 30, 2016

While libraries shouldn't commit the vendor directory to version control, there are instances where it might be beneficial for projects to commit the vendor directory.

Open for discussion, consider revising the vendor/ section to read:

The vendor/ directory MUST be reserved for use by package managers (e.g.: Composer).

If the repository type is designated as a "project" in its composer.json file, the vendor/ directory SHOULD be ignored by revision control tools (e.g.: Git, Mercurial, Subversion, etc.). It SHOULD NOT be committed to revision control repositories.

If the repository type is designated as a "library" (the default) or otherwise in its composer.json file, the vendor/ directory MUST be ignored by revision control tools (e.g.: Git, Mercurial, Subversion, etc.). It MUST NOT be committed to revision control repositories.

This publication does not otherwise define the structure and contents of the directory.

@pmjones
Copy link

pmjones commented Dec 30, 2016

This is a very good point. Now that I think about it, I have tried very hard to support each point in the draft with research. However, the bits about "not committing to version control" are a habitual bias toward Composer, and not strictly supported by the findings. Perhaps the thing to do is say "reserved for package managers ... not otherwise defined" and leave the rest out?

@ramsey
Copy link
Author

ramsey commented Dec 30, 2016

I think that will suffice.

@pmjones
Copy link

pmjones commented Dec 30, 2016

Indeed, on further consideration, the research shows a lack of vendor/ directories. That's because Composer says (effectively) "this is reserved, don't use it." I wonder if leaving it out entirely would make even more sense.

@pmjones
Copy link

pmjones commented Dec 30, 2016

@ramsey You might want to submit a PR with the changes you'd like to see, because then you get automatic credit via GitHub. (You can go so far as to remove the vendor/ stuff entirely if you like, and reference this issue.)

@ramsey
Copy link
Author

ramsey commented Dec 30, 2016

Will do. Thanks!

@pmjones
Copy link

pmjones commented Jan 2, 2017

@ramsey If you don't think you'll get around to it in the next couple of days, I can take care of it. Let me know!

@ramsey
Copy link
Author

ramsey commented Jan 2, 2017

It'll be a few days before I can get to it. I haven't had Internet access since December 16. Long story. :-)

@pmjones pmjones closed this as completed in 82d143d Jan 3, 2017
@pmjones
Copy link

pmjones commented Jan 3, 2017

Noted, and good luck with the internet situation.

@ssmusoke
Copy link

This is just me thinking - why not add a vendor directory and a .gitignore file (excluding it) so that it is clear that the directory exists but is ignored

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

3 participants