Add README and CONTRIBUTING about php HOT 10 CLOSED

Actually, all the docker-library official image projects have their docs over in docker-library/docs. But we probably should add something in each repo that explains this.

from php.

Yes, I saw your comment in the other isse and I must admit it is a bit confusing.

Would it be technically possible to have those documents in this (and other) repositories and pull them in into the global repository? Having the Dockerfiles and the related documents in separate repositories makes it hard (if not impossible) to create pull requests if changes have to be made in both.

I can imagine this makes it harder for you as a maintainer as well.

from php.

It is actually easier to have the documentation in one place so that we can generate the common parts, but it would be helpful to tell contributors where they could update docs if their PR needs it.

from php.

Ok. Was thinking if using git submodules would be an option, but probably hard to maintain as well. The problem I see here is that PRs won't be really "atomic" and the docs are sometimes overlooked (tags are out of sync for various images on the registry)

However, I'm getting off topic now; perhaps;

• add a CONTRIBUTING.md here, with intructions (e.g. How to test your changes and what the update.sh is for :))
• a minimal README.md to make Github happy and that contains links to the docs repo.

from php.

That sounds good and if it generic enough, can be applied to all of the Official Images with minimal changes.

from php.

Something you'll take care of, or do you prefer a PR? Can't make promises due to time constraints, but can try to make a start when I get home (commuting)

from php.

If you want to give it a shot, sure. Don't worry too much about speed, you are volunteering and I am grateful.

from php.

I'll see what (and when, LOL) I can come up with

from php.

@thaJeztah, think we can close this? There is a README now and info about contributing is on the linked docs. Do we still need a contributing.md in all the repos?

from php.

Yes, let's close this: a contributing.md is only cherry on the cake :-)

from php.