Add contribution guidelines

[mkunkel]

As we open this up to the public for contributions, we need to make sure we are clear on how we expect the community to contribute.

This should be made clear in a CONTRIBUTING.md file (see more) We can also discuss the merits of having our guidelines enforced via GitMagic

[Meekohi]

See Pull Request #126 for discussion about what should go in here.

[kweerious]

@mkunkel are you good with the copy merged?

[mkunkel]

I think it's a good start. There are a couple places that I could see room for improvement:

• Stating that commit messages should be descriptive
• I think that signing off from two developers is a bit much for our needs.

[kweerious]

I agree with the note about commit messages. Maybe we should link that better git commit blog post?

I think we can also substitute the GitHub code review approval for signoff and not make it a number per se. If someone has change requests that will show up.

[mkunkel]

I have Github reviews turned on for this repo. I think it would be good to set the expectation that it will go through that process.

Having said that, I am not certain that the review system requires that a member of the organization approve the changes. There does not seem to be a setting for that.

[kweerious]

There's a merge block for unapproved PRs that can be set per branch.

.dd

[mkunkel]

Right, that is set on master. A PR must be approved before it can be merged into master. What I am saying is it doesn't seem to be granular enough to require that the approval comes from someone within the WFTDA Github org.

[kweerious]

Ah, yeah but only certain members from the Org will have merge so that part will be enforced by them.

[mkunkel]

Good point. That resolves my concern.