On 09/13/2018 09:39 AM, Fabiano Fidêncio wrote:
Let's add some instructions and examples on how to contribute with the most basic scenarios of adding an OS info to osinfo-db. -- While do think this is useful material to point to newcomers, I'm totally fine about having it as a blogpost or somewhere else than our git repo. Also, I do believe that we can start growing the amount of docs/examples we have and that it can help people to start helping us with some basic patches of their favourite distro. I'm looking forward to receiving some feedback about this and suggestions on how this could be done better. :-) --
The content is very nice! It's definitely useful to have some place to point people for these details. Generally rather than diffs in the file I'd say just point people to either email postings, or gitweb commits, if they want the particular details.
I like the idea of identifying a few common tasks like adding new OS, adding isodata, adjusting EOL dates, and referencing those in the contributing doc, but storing the details elsewhere. Maybe a blog or wiki page if it has lots to explain (does gitlab have wiki pages like github?), or just a mailing list or git example link for something simpler like EOL adjusting
Generally I think a contributing doc should be 1-2 pages (don't want it to scare people away) and just hits the major points like common building from git, running the test suite, and anything deeper should be links to more info.
Signed-off-by: Fabiano Fidêncio <fidencio@xxxxxxxxxx> --- CONTRIBUTE.md | 930 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 930 insertions(+) create mode 100644 CONTRIBUTE.md
FWIW on github this type of document is typically called CONTRIBUTING.md and infact has some special meaning: https://blog.github.com/2012-09-17-contributing-guidelines/
Thanks, Cole _______________________________________________ Libosinfo mailing list Libosinfo@xxxxxxxxxx https://www.redhat.com/mailman/listinfo/libosinfo
