Contributors Guide

[anvilresearch]

Contributors Guide

[christiansmith]

Agreed on priority. I'll post a few thoughts on content specific to this project here later today.

[christiansmith]

Git message conventions we use to generate the changelog need to be documented or referenced in the contributors guide.

[christiansmith]

Here are a few more topics that ought to be covered:

• code conventions
• pull requests – how to group/separate commits, etc
• code reviews
• testing – how to run tests, testing conventions, when tests are required, etc.
• licensing (i.e., don't copy/paste GPL'd code, etc)
• call for contributions – some folks may want to get involved but don't know where to start. It would be good to point out some low hanging fruit.

Some of this may overlap a bit with governance, the CLA issue, etc.

[bnb]

I can work on this - I'll send a PR in the next few days.

[christiansmith]

@bnb let's try to work in the open as much as possible. Once you start drafting this up, I think you'll find we still have a lot of questions to answer.

[Cynfusion]

As we move forward on this, I'd expect we would want to be sure and cover (among other things, such as the list above):
-How we work ( @christiansmith please weigh in here especially)
-What we value (openness, honesty, collaboration, clean code) ( @christiansmith among other things I am sure)
-Issues and Pull Requests
-Technical HowTo
-Issue Contributions
-Code Contributions
-Some kind of "Hot Top Ten" things people can jump in to easily

How are we coming, @bnb?

[adalinesimonian]

Is there an update on this issue?

[Cynfusion]

Yes, it's in my repository still. I suggest we meet w Christian this week and discuss and then merge it.

[adalinesimonian]

Sweet! I'm super excited.

[adalinesimonian]

PR #22

[adalinesimonian]

PR #22 has been manually merged by @christiansmith. Marking issue as needing review.