openfaas / docs

Official Docs for OpenFaaS
https://docs.openfaas.com/
MIT License
67 stars 102 forks source link

Add instructions for forking/cloning and raising a PR for Go code #114

Open alexellis opened 5 years ago

alexellis commented 5 years ago

Proposed change

On the getting started doc, write a complete worked example for cloning/forking and raising a PR with Go code. https://docs.openfaas.com/contributing/get-started/

Detail flow with example commands for one of the repos:

Add a note on how to sign a commit / amend it if someone got this wrong.

Context

Suggested by @bartsmykla during review of How to Contribute presentation

Your Environment

rgee0 commented 4 years ago

Since Get Started has been split out for being too long, should the response to this issue form the basis of content for a new page under Contributing?

Maybe a third menu item called 'My First PR'?

Contributing

jonatasbaldin commented 4 years ago

Agree with @rgee0 :)