r-devel / rdevguide

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

explicit patch submission instructions #177

Open shannonpileggi opened 1 month ago

shannonpileggi commented 1 month ago

Recently at R Dev Day PLUS, Martin commented on how to submit the "perfect" patch. I see a related section in 7.4.1 & 7.6, but I don't think it as explicitly goes through all the steps regarding the attachment and such??

https://github.com/r-devel/r-svn/pull/172#issuecomment-2228696800

Appending .diff to the end of the [r-svn PR] URL automatically provides something you save from your browser as plain text file, named, e.g., toTitleCase_PR-18674.diff and then in R's bugzilla, you'd typically use the Add an Attachment option to add that *.diff file as attachment:

vs what was initially submitted: https://bugs.r-project.org/show_bug.cgi?id=18674

fyi @sarahzeller @reikookamoto @Bisaloo

llrs commented 1 month ago

I think this is very useful and it would be great to add it to the book to annotate what was previously shared on individual cases. Perhaps @SaranjeetKaur who originally wrote the section can provide more feedback (or add it to the book).

SaranjeetKaur commented 1 month ago

Thanks for the tag @llrs and I agree with you that it would be great to add this to the dev guide.

@shannonpileggi - would you like to open a PR about the same?

shannonpileggi commented 1 month ago

Sure, will do! Thanks for the feedback!