Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributor Documents #3

Open
s2t2 opened this issue Nov 6, 2017 · 0 comments
Open

Contributor Documents #3

s2t2 opened this issue Nov 6, 2017 · 0 comments

Comments

@s2t2
Copy link
Contributor

s2t2 commented Nov 6, 2017

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
@s2t2 s2t2 removed their assignment Nov 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant