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

Clarify team member contribution policy #76

Open
matthew-reynolds opened this issue Mar 13, 2019 · 3 comments
Open

Clarify team member contribution policy #76

matthew-reynolds opened this issue Mar 13, 2019 · 3 comments

Comments

@matthew-reynolds
Copy link
Member

matthew-reynolds commented Mar 13, 2019

📖 Documentation Error

Our CONTRIBUTING.md is a bit confusing and doesn't do a good job of explaining that within-team members should contribute by creating branches within the main repo, as opposed to external contributors who should fork. Need to clarify this language.

@ghost ghost self-assigned this Mar 29, 2019
@matthew-reynolds
Copy link
Member Author

Elevating to urgent - This doesn't block any specific other issues or anything, but it's a fairly significant barrier to getting more collaborators involved. In particular, this must be done before our next recruiting round completes so that the new team members have a smoother experience joining the team.

@matthew-reynolds
Copy link
Member Author

Other things to add to the guide:

1) No force pushing

2) Clarify how to commit. Commit messages must:

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how

We should add that the body is optional, maybe change the imperative to "imperative or past-tense" since even though that's incorrect and inconsistent, it's more in line with how things are likely to be done. Idk I have mixed opinions on that last one.

Adding a couple examples of good commit messages might also be a good idea.

@wmmc88
Copy link
Member

wmmc88 commented Jun 25, 2019

@michaelwm thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants