artsy / README

:wave: - The documentation for being an Artsy Engineer
Creative Commons Attribution 4.0 International
1.1k stars 120 forks source link

Improve clarity around rfc process #518

Closed jonallured closed 1 year ago

jonallured commented 1 year ago

I was very confused yesterday about the current RFC process. The last time I made an RFC it was an issue on this repo so I assumed that was still the way. Then I found in the root README of this project a link to create an issue so I clicked it. I expected to see an issue template populate but it didn't so then I was confused. I asked on Slack here:

https://artsy.slack.com/archives/CP9P4KR35/p1691010929981279

And the hive mind steered me towards re-creating the template. This was incorrect.

The next day my pal @lidimayra noticed my mistakes and confusion and linked me to the playbook and the RFC where we changed course - RFCs should be authored as markdown files in the /RFCs folder and then a PR should be opened to discuss them. I had completely missed this development!

So then I thought the right thing to do would be to come back to this repo and cleanup things that caused me confusion to hopefully save the next person from making my same mistakes.

I think this is better and should result in less confusion but it's probably not perfect - what did I miss?