community icon indicating copy to clipboard operation
community copied to clipboard

"First Contribution Guidelines"

Open mikeal opened this issue 6 years ago • 2 comments

An idea we've been kicking around lately is to create a set of guidelines, similar to our existing contribution guidelines, that are paired down quite a bit in order to encourage first time contributors.

These guidelines could exclude a lot of the extra learning we expect long term contributors to do and would be small enough that people new to the project will read it and easily grok it. It could also be linked to by automation for first time contributors.

mikeal avatar Dec 16 '18 17:12 mikeal

@mikeal This is something that I had in mind as well. My goal is to make a contributor guideline that is the TL:DR version of the guideline that we already have in place. It is hard to find projects that do this well, but I think we would be on the right track if we created a shorter and more interactive version of Django's Writing Your First Patch.

Many open source projects don't do a good job of introducing git and the mechanics of contributing to brand new contributors in an accessible way. We should strive to level-up new contributors by providing info on git and how to submit a patch. Some good git resources include:

First Contributions Git and Github Tutorial for Beginners

pkafei avatar Dec 17 '18 11:12 pkafei

Thanks for the First Contrib links, as an exercice I wanted to add a hash in go-multihash and recompile a fork of go-ipfs, but was not successful I got stuck with the "official" go-multihash, I am not very familiar with go and gx so I am not sure how to make the go build / make to get the new "deps" ?

can someone explained to me how to deal with the package.json, go.mod, go.sum files for a successful recompile ?

Thanks you

iglake avatar Apr 14 '19 14:04 iglake