python-tooling icon indicating copy to clipboard operation
python-tooling copied to clipboard

[TASK]: Agree on and potentially document a process for recording outcomes of off-GitHub discussions

Open matt-graham opened this issue 1 year ago • 2 comments

What needs to be done?

Following on from discussion in thread of #288. We sometimes have conversations about this project off-GitHub - for example during the semi-regular in-person hackathon events we've been running or on the internal ARC Slack workspace. To make sure those not present in these discussions are aware of the points raised and the rationale behind any decisions made, I would suggest we should have some minimal process around ensuring we sufficiently document such conversations to allow everyone the chance to contribute.

We generally already create issue corresponding to any decision about changes to be made, but sometimes these have been very barebones and not had any summary explaining why a decision was made. I would suggest we just ensure that in any such issue we give a (potentially very brief) summary of the points made in the initial issue comment. We could potentially even have an issue template specifically for this, though not entirely sure that makes sense?

matt-graham avatar Jan 24 '24 18:01 matt-graham

I acknowledge that #254 could have done with more text in the leading comment.

But FWIW I'm also OK with the workflow that we ended up having. It seems sane to me...

  • Potentially contentious changes were explicit in the name of the issue and PR,
  • comment challenging the decision on the PR was raised and PR marked as "changes requested" because changes were requested,
  • ...discussion ensued.

Modulo that I disagree with the comment here. In-person decisions are not final. Differing opinions are welcome. This is now explicitly codified in line 21 of our CoC.

samcunliffe avatar Jan 25 '24 09:01 samcunliffe

I would suggest we just ensure that in any such issue we give a (potentially very brief) summary of the points made in the initial issue comment.

I'm 👍 this - it makes it much more inclusive as a project if everyone can see why decisions have been taken, and I don't think it adds much more effort on top of in person discussions to jot reasons behind a decision down. Indeed, it also helps remember why a decision has been taken later - I think someone who was in person commented on a thread somewhere that they had forgotten why a decision had been made!

dstansby avatar Jan 25 '24 10:01 dstansby