openfaas / openfaas/docs

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

Open
#114 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
67
Forks
94
Avg merge
5h 51m
Merged PRs (30d)
1

Description

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:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the getting started guide at https://docs.openfaas.com/contributing/get-started/. Add a complete Go example covering the listed fork, clone, remote, change, test, sign-off, push, pull request, and issue-reference steps, including how to correct a missing commit signature. Done means a newcomer can follow the example end to end.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.