Modal icon indicating copy to clipboard operation
Modal copied to clipboard

Add a contributor guide

Open chrissainty opened this issue 5 years ago • 6 comments
trafficstars

We currently don't have a contributor guide and this makes it hard for people to know how they should go about contributing to the project.

Decide on what the contribution guidelines should be and add a new document to the repo to allow new contributors to understand our process.

chrissainty avatar Mar 20 '20 12:03 chrissainty

Hi @chrissainty, I made an initial setup of the contributing guide. Let me know what you think! It was just something I put together quickly but it might be a good starting point.

Also, do you think we should add a code of conduct? If so, we can just use one of the standard ones provided by github I think.

Let me know!

larsk2009 avatar Apr 09 '21 18:04 larsk2009

@larsk2009 that's a great start! I've made a few changes, if you could take a look and see what you think.

I remove the point about updating the docs stuff. That isn't being deployed anymore and I think we probably should remove it to avoid confusion. I think we should focus on making the WebAssembly sample a living doc.

Great idea about the code of conduct. We should definitely add one!

chrissainty avatar Apr 10 '21 09:04 chrissainty

Yeah I agree removing the separate docs. The rest of the changes seem great to me!

larsk2009 avatar Apr 10 '21 10:04 larsk2009

What needs to happen with this now? Do we just need to link to it from our issue templates and the readme?

chrissainty avatar Apr 17 '21 07:04 chrissainty

Uhm yeah I think the important thing is the contributing file should be in either the root dir, .github or docs for github to automagically use it. Maybe we can merge it first, and see if it shows up when making an issue or PR or if we need to link to it in the PR/issue template.

larsk2009 avatar Apr 19 '21 17:04 larsk2009

Sounds like a plan to me

chrissainty avatar Apr 24 '21 08:04 chrissainty