Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
alexellis opened this issue Jan 16, 2019 · 2 comments
Open

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

alexellis opened this issue Jan 16, 2019 · 2 comments

Comments

@alexellis
Copy link
Member

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:

  • Find issue
  • Ask to work on it
  • Fork repo
  • Clone original repo
  • Add new remote side
  • Make a change
  • Test it
  • Sign-off commit
  • Push to remote
  • Raise PR
  • Fill out template
  • Reference PR on issue
  • Tell us about it

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

  • FaaS-CLI version ( Full output from: faas-cli version ):

  • Docker version docker version (e.g. Docker 17.0.05 ):

  • Are you using Docker Swarm or Kubernetes (FaaS-netes)?

  • Operating System and version (e.g. Linux, Windows, MacOS):

  • Link to your project or a code example to reproduce issue:

  • Please also follow the troubleshooting guide and paste in any other diagnostic information you have:

@rgee0
Copy link
Contributor

rgee0 commented Oct 1, 2019

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

  • Get Started
  • Main Repositories
  • My First PR

@jonatasbaldin
Copy link
Contributor

Agree with @rgee0 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants