WARNING: This repository is no longer maintained :warning: This repository will not be updated. The repository will be kept available in read-only mode. See https://developer.ibm.com/code/patterns/ for the latest patterns.
Ooh, I didn't catch that. I'll revise this PR. I'm looking to standardize all of our repos to have the license in LICENSE, without an extension (although it is definitely plain text).
README is a separate issue and can be in whatever format the project desires; however, I've seen README.md as the most popular option within IBM (as in this repo). And FWIW, I'd like to stick to Markdown for all of our repos (although, I personally prefer RestructuredText, I think it's far more important that we standardize on one solution).
However, if you meant "LICENSE" instead of "README", then I think the answer is more interesting :) GitHub actually documents one convention and implements another. GitHub's documentation on the topic suggests LICENSE.txt, and GitHub's licensing tool creates a LICENSE file (example repo, specifically to illustrate the result). And again, we have far more LICENSE files than anything else (there were a couple LICENSE.md files as well), so I'm looking to standardize on that.
Ooh, I didn't catch that. I'll revise this PR. I'm looking to standardize all of our repos to have the license in
LICENSE, without an extension (although it is definitely plain text).READMEis a separate issue and can be in whatever format the project desires; however, I've seenREADME.mdas the most popular option within IBM (as in this repo). And FWIW, I'd like to stick to Markdown for all of our repos (although, I personally prefer RestructuredText, I think it's far more important that we standardize on one solution).However, if you meant "LICENSE" instead of "README", then I think the answer is more interesting :) GitHub actually documents one convention and implements another. GitHub's documentation on the topic suggests
LICENSE.txt, and GitHub's licensing tool creates aLICENSEfile (example repo, specifically to illustrate the result). And again, we have far moreLICENSEfiles than anything else (there were a coupleLICENSE.mdfiles as well), so I'm looking to standardize on that.