[rdo-dev] README in distgit projects

Haïkel Guémar hguemar at redhat.com
Mon Apr 2 06:18:45 UTC 2018


On 04/01/2018 10:43 PM, David Moreau Simard wrote:
> Hi,
> 
> Chris Dent rightfully pointed out that we don't typically have a
> proper and up-to-date README in our distgit repos [1].
> 
> Can we/should we fix that ?
> The README could be an appropriate place to document small things like:
> 
> - Link to review.rdoproject.org scoped for this repository's reviews [2]
> - Quickstart: git clone, edit, git review (and mention no pull requests)
> - Link to packager documentation
> - Other things
> 
> Probably even something worthy of easyfix [3] ?
> 
> [1]: Example: https://github.com/rdo-packages/nova-distgit
> [2]: Example: https://review.rdoproject.org/r/#/q/project:openstack/nova-distgit
> [3]: https://github.com/redhat-openstack/easyfix
> 
> David Moreau Simard
> Senior Software Engineer | OpenStack RDO
> 
> dmsimard = [irc, github, twitter]
> _______________________________________________
> dev mailing list
> dev at lists.rdoproject.org
> http://lists.rdoproject.org/mailman/listinfo/dev
> 
> To unsubscribe: dev-unsubscribe at lists.rdoproject.org
> 


dist-git repositories usually do not provide READMEs.
Unless there's a good reason, I'd prefer keeping consistency with 
external dist-git repositories.

Regards,
H.


More information about the dev mailing list