Develop contribution guide

[bilsch]

We will need to develop some kind of guide which will give clear instructions for how to go about contributing to the source code, documentation etc.

I think the github setting guidelines for repository contributors docs cover this pretty well. We would want to implement this to a standard github project as a template.

We will want to come up with at a minimum the CONTRIBUTIONS.md for the repositories to all use. The guidelines doc mentioned previously has links to a few examples.

We should likely also have standards for pull request templates

[bilsch]

One thing we may want to consider here is to have participants contribute a PR for a CONTRIBUTORS.md file in the main repo and then include that somehow in the wiki - thoughts?

[tchellis]

Is there a cliff notes version that relates to how the TWG can use it simplify our collaboration?

[bilsch]

re-posting a side conversation with @tchellis

The ask here, as I have parsed it, is to develop some kind of statement with how we intend to function within the context of using github issues and wiki along with whatever resultant documents / procedures would come of these efforts.

The request was less to do specifically with the contributors.md document creation itself and more how the workflow fundamentally works. I recommend we discuss this as part of the call 10/31 and let the group decide these questions to some degree.

My opinion which was shared is along the lines of the wiki being more of a document index with topics pointing around to the work and/or the github issues which is where the discussion / work would happen. The output of the issue would be to create some kind of document which is then a part of the wiki content itself.

[rubberduck203]

I feel like developing a CONTRIBUTING.md is premature and possibly out of scope for this group. The contents of that file will vary repository by repository and the people best suited for writing those will be the core dev team.

I do think it’s in scope for us to recommend that they get created though.

[bilsch]

There has been some discussion in #14 about developing a contribution guide being somewhat out of scope for the twg. Recommending that one be created is within scope.

I do agree with this assertion so for now this issue will be detached from the milestone. We can re-visit this later.