jaybee84 / ml-in-rd

Manuscript for perspective on machine learning in rare disease
Other
2 stars 1 forks source link

CONTRIBUTING: When editing, separate pull requests for text changes and renaming #86

Closed jaclyn-taroni closed 4 years ago

jaclyn-taroni commented 4 years ago

Discussed in today's meeting:

Currently different sections are in their own files, e.g., content/03.prior-knowledge.cascadelearning.md and content/03.prior-knowledge.knowledge-graphs.md. In #79, files that hold a different section are being combined and renamed, but there are also smaller text based changes like removing sentences that are no longer needed. However, because of the file renaming the diff shows all text as added: https://github.com/jaybee84/ml-in-rd/pull/79/files

It would be desirable to have visibility into these smaller changes, so the procedure could be dividing such changes into two pull requests:

  1. Any text changes like changing the wording of sentences and removing unnecessary sentences, etc.
  2. Any filename changes

The first pull request would allow reviewers to see the substantive changes and the second PR would be a 10 second 👍 kind of deal.