Hi,
as part of a Hack Week project [1], some members (and one non-member :-)
of the Prague SUSE YaST team decided it is a good idea to add the
following two files with standardized content to each YaST GitHub
repository:
* README.md
* CONTRIBUTING.md
The README.md file would provide a visitor of the repository with the
description of given YaST module, basic installation & usage
instructions and pointers to other documentation. Content of this file
would be similar (but not exactly the same) for each repository.
The CONTRIBUTING.md file would be displayed in GitHub UI when a
contributor creates an issue or opens a pull request [2]. It is a
convenient place to put basic contribution guidelines and pointers to
development documentation. Content of this file would be exactly the
same for each repository.
We didn't discuss the idea of adding these files with the rest of YaST
community so far, because we felt it is non-controversial. In the next
paragraphs, I'll assume you generally agree with it -- if that's not the
case, or you have some comments, please speak up now.
As a flollow-up to the Hack Week project, I finished a draft of the
CONTRIBUTING.md file today:
https://github.com/yast/yast-nfs-server/pull/11
Let me know what you think about it in comments on GitHub. My plan is to
adapt the draft if necessary and once it's stable, I'd like to
mechanically add the file to all relevant non-dead repositories inside
the YaST organization. If all goes well, I assume I'll do that at the
beginning of the next week. After that, I'd like to look at REAMDE.md.
[1] https://hackweek.suse.com/projects/132
[2] https://github.com/blog/1184-contributing-guidelines
--
David Majda
SUSE developer
--
To unsubscribe, e-mail: [email protected]
To contact the owner, e-mail: [email protected]
