pln-planning-tools / Starmap

Roadmap Planning Tool
https://starmap.site
Other
20 stars 8 forks source link

Add contributor guides (`CONTRIBUTING.md`) #79

Open AlexxNica opened 1 year ago

SgtPooki commented 1 year ago

need to define our contributing guidelines, or find an existing example to copy

AlexxNica commented 1 year ago

@SgtPooki any specific examples you want to use?

Here are some that I suggest we can use as inspiration:

TypeScript and vscode are more detailed and have sections specific to coding. They also have wikis for more in-depth guides:

Another example is Kubernetes' contributing docs, which is very comprehensive. IMO we probably don't need the same governance processes involved in Kubernetes right now, so we can just use it as inspiration and get some pieces here and there that are relevant to our project, but not everything.

SgtPooki commented 1 year ago

I think leaning more into the existing contributing docs for ipfs repos makes the most sense, but those are great for ideas for improvements.

Some existing contributing docs:

I think a mix of the following two would be good: