r-devel / rdevguide

A guide for contributing to R core development
https://contributor.r-project.org/rdevguide/
Other
60 stars 19 forks source link

add a new section in documentation chapter #118

Open SaranjeetKaur opened 1 year ago

SaranjeetKaur commented 1 year ago

In the introduction, you mention reporting bugs in documentation and actually this is probably the main way that people contribute. It might be helpful to expand on what is a bug in documentation - perhaps with a couple of examples of reporting a typo or reporting something that is no longer correct. If an R Core developer agrees there is a bug, they will typically fix this directly, so there is no need for anyone to contribute a patch.

For larger issues, people can contribute by raising larger issues with documentation (unclear or incomplete documentation), discussing how these issues might be addressed and potentially contributing a patch if there is support from R Core. I think the comment about R Core not necessarily accepting patches might go here - although I agree the introduction should not give the impression that any and all documentation contributions will be welcome.

So this should all come before discussing how to find documentation issues on Bugzilla. Taking Nicolas' point about the metadata, I think it is still helpful for people to know how to browse documentation issues without needing a directly link. So perhaps something like "Select "Browse" in the navigation bar, select the "R" category and then select the "Documentation" component ([direct link to Documentation bugs]())".

_Originally posted by @hturner in https://github.com/r-devel/rdevguide/pull/66#discussion_r982067403_