Closed mwheeler closed 2 years ago
Looks good, most comments are typos. I think the content is complete.
One question, do we want to include newlines at the end of text files?
Fixed in all current issues in ec55731
As for the newlines at end of text file... that's already a PEP-8 thing (also, technically - text files by definition "must" have a newline at the end of every line in unix terms, not sure if windows shares this) - there's even some old school programs that won't work properly w/o newlines at the end of text files (though they're becoming rarer and rarer)
This PR adds the basic project governance docs you'd expect a project to have, specifically:
Note: It's written in a future-facing capacity assuming we have open sourced and thus have Github Actions setup to prevent PRs from merging if linting or unit testing fails (this is not currently the case, but it is the intended end goal for our QA standards once we open source)
Edit: This addresses #356 (which ironically didn't exist before starting this work, contrary to the guides! for some reason I thought the other documentation issue we had open also covered these governance docs)