This repo should include the following documents to facilitate and encourage contributions:
Issues Template: .github/ISSUE_TEMPLATE.md
PR Template: .github/PULL_REQUEST_TEMPLATE.md
Contributor's Guide: CONTRIBUTING.md
Important dev process notes from my perspective include:
PRs will be merged using the "Squash and merge" strategy, which incorporates all of the PR's commits into a single commit. This keeps the commit history clean. Note: I've already configured this repo's settings so "Squash and merge" is the only available merge option.
PRs, before being merged, should be reviewed by an official contributor/admin, hopefully someone other than the PR's main contributor
PRs, before being merged, should undergo some automatic checks (like CI, when we get there, but also I was hoping to find some platforms in the GitHub marketplace which perform spell checks and content suggestions like "don't use passive voice here")
I propose we use the labels "ready-for-review" or "not-ready-for-review" to be very explicit about whether or not a PR is ready for review
This repo should include the following documents to facilitate and encourage contributions:
.github/ISSUE_TEMPLATE.md.github/PULL_REQUEST_TEMPLATE.mdCONTRIBUTING.mdImportant dev process notes from my perspective include: