[openstack-dev] [openstack-sdk-dotnet][openstack-cli-powershell] readme and contributing guide

Matthew Farina matt at mattfarina.com
Wed May 21 19:32:07 UTC 2014


It would be useful to have top level readme and contributing guides for
these two projects. I was going to round out both of these and wanted to
know what format would be good to use. Here's what I found.

First, a lot of .NET projects don't have top level files. I understand how
visual studio treats these and how useful they are in practice for working
with and on a project. It doesn't fit well.

That being said, when someone encounters one of these projects on the
github mirror or elsewhere it would be useful for someone looking to get
started. .NET projects on github test to have readmes.

The most popular format I found, by far, was to use markdown.

If a README.md and CONTRIBUTING.md (as markdown) are ok to go with I'm
happy to craft the initial (or latest) versions of these.

Markdown seems to fit the most here. RST is something I've not seen used by
any .NET projects.

Sound good? Other thoughts?
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20140521/31db8cd8/attachment.html>


More information about the OpenStack-dev mailing list