Hi! > Are there tools that automatically locate README.source and would need to be > adapted to > find README.source.md instead ?
Not to my knowledge. This file is consumed by humans / Debian maintainers to learn about the source package. Most likely it is accessed by typing $EDITOR debian/README.s<tab> and whatever follows will be autocompleted. Having the actual suffix is important for the file to be rendered consistently by all editors and viewers. Examples of existing use: https://salsa.debian.org/debian/entr/-/blob/debian/latest/debian/README.source.md https://salsa.debian.org/js-team/jquery/-/blob/debian/3.0.0_alpha1+dfsg-2/debian/README.source.md https://salsa.debian.org/xen-team/debian-xen/-/blob/debian/4.11.1_pre+1.733450b39b-1_exp1/debian/README.source.md https://salsa.debian.org/samba-team/samba/-/blob/master/debian/README.source.md In the case of the Samba package https://salsa.debian.org/samba-team/samba/-/blob/master/debian/README.source is a symlink to the Markdown file. Markdown is widely used for README in the Free and Open Source Software ecosystems, see e.g. https://github.com/git/git/blob/master/README.md and https://github.com/openssh/openssh-portable/blob/master/README.md. They are used specifically with the .md suffix and not via emacs/vim configs. I don't think the policy needs to say anything about symlinks or anymore about the contents than what it is already saying. My suggestion is simply to mention the .md file type so people know they are allowed to use it, and potentially people planning some scanning/automation will note to look for debian/README.source* instead of just a single plain-text file. Thanks!
