ipfs / helia

An implementation of IPFS in JavaScript
https://helia.io
Other
904 stars 95 forks source link

Document our development and contributing guide #82

Open BigLep opened 1 year ago

BigLep commented 1 year ago

Done Criteria

There is an easily discoverable document that bootstraps someone on contributing, sets expectations of contributors/developers, and answers related frequently asked questions.

Why Important

Having a community of contributors is a key success criteria for Helia. I hypothesize that documentation here helps makes contributing more approachable/self-service.

Notes

I know we link to https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md. It looks like that has some older stuff. I think we either need to update that doc inline, copy it and make updates, or create an addendum with Helia specifics and then link to https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md. I expect we want our own place to add copy just so there is no friction to be documenting Helia-related things. I worry folks would shy away from touching https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md because they don't know whereall it's linked from or because Helia specifics aren't relevant there.

Items that would want to see included:

SgtPooki commented 1 month ago

We should make most contribution changes in CONTRIBUTING_JS.md, but we should have a CONTRIBUTING.md in this repo, that links to CONTRIBUTING_JS.md, and then calls out Helia specific contribution things: