uwreact / uwreact_robot

Software behind our fully autonomous FIRST robots
BSD 3-Clause "New" or "Revised" License
8 stars 6 forks source link

Clarify team member contribution policy #76

Open matthew-reynolds opened 5 years ago

matthew-reynolds commented 5 years ago

📖 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.

matthew-reynolds commented 5 years ago

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 commented 5 years ago

Other things to add to the guide:

1) No force pushing

2) Clarify how to commit. Commit messages must:

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 commented 5 years ago

@michaelwm thoughts?