Add some details about merging before review and merging without edits - Githubissues

rossyndicate / ROSSyndicate_best_practices

ROSSyndicate best practices repository. A one-stop shop for the lab's coding best practices.

https://rossyndicate.github.io/ROSSyndicate_best_practices/

MIT License

1 stars 3 forks source link

Add some details about merging before review and merging without edits #25

Open steeleb opened 1 year ago

steeleb commented 1 year ago

Merging before review:

author must make note in comments
be clear about whether tagging someone in a review is about an FYI or about an actual review that is required
it is the author's responsibility to follow up and make sure that all comments/suggestions/reviewers are satisfied later

Merging without edits/merging when 'changes requested'

sometimes, you just gotta keep chugging!
Make sure you (PR author) creates issues from review so that we don't inadvertently miss important info and feedback
Make sure you make a note in comments of the PR to communicate what has been done and what is left to do (and call out the issues created)