Lately we’ve been discussing how cultivating review culture
across SourceCred will help us stay aligned as we grow our community. In
particular, I think we should start producing shared “docs artifacts”
that we’ve reviewed and we stand behind as a community. By “docs
artifacts” I mean both things like user guides, and also community
So, to kick things off, I wrote this guide on review culture, which I
hope will be one of the first docs artifacts. Please review the pull request and let
me know what you think.
If you aren’t quite sure how to review a pull request on GitHub, please ask questions in the Discord and I or others will be happy to help!
Read through the guide. Looks good, but it seems especially applicable to code review. Is it meant as a guide for developers, or for all SourceCred community members across all domains of contribution? If the later, I’d suggest exploring changes to the language.
Also, the guide is submitted to a GitHub Docs repo. Is the idea to aggregate docs for developers on GitHub, or to aggregate all SourceCred docs in that repo?
This is meant to be a guide for everyone in the SourceCred community.
Please share the improvements you have in mind on the review. I know reviewing from the perspective of code review in particular, so it makes sense if my draft is oriented that way.
I’d like to aggregate all the SourceCred docs in that repo. For accessibility, we’ll also mirror the merged docs into an official category on the Discourse.