Add vignette to help users debug low scores

[graceannobrien]

• check that .Rbuildignore does not have NEWS.md in it

[kylebaron]

It would be great if we could start collecting this information on a Wiki page or something like that so we don't have to wait for a vignette to get released to have access to the information.

[seth127]

Thanks for putting this in @graceannobrien. This is (almost) a duplicate of #24 (which should probably be renamed to be more general). That issue does have some more detail in it though, which is hopefully helpful in the short term.

I think these will likely be closed at the same time, though I do like @kylebaron 's idea of starting an easily accessible list somewhere, until we document this more formally. @kyleam or @barrettk do you have any thoughts on where that list could live? Maybe just in one of these two issues?

[kyleam]

do you have any thoughts on where that list could live? Maybe just in one of these two issues?

I think in this issue would make sense because 1) it'd serve as todo list for that, 2) given the title, it's probably somewhat discoverable, and we could even temporarily point to it in the README. I'd be okay with a wiki page if others think that'd be better, though we should remove it after the fact so that we're not maintaining the info in two places.

(Or, if you rename gh-24 to be more and close this one, of course gh-24 would be the better spot.)