openstack/training-guides
Code Issues Proposed changes
Files
f6ba1897112ba21d6654e275adbe2692794230ac
training-guides/doc/upstream-training/source/19-training-contribution-process.rst
Ian Y. Choi dce7b520c9 [upstream] Minor polish in module 19 
- address review comments in https://review.openstack.org/#/c/366255/
- add '$' prompt in code blocks
- better URL display in page 3: "Getting to Know Your Project"
- divides into two "General Contribution Workflow" pages
  (Contents are too much not to cover with just one page.)

Change-Id: I0ba424af517037dda9e9c80a3c9d444a1cf73cc0
2016-09-23 02:48:43 +09:00

2.4 KiB
Raw Blame History

Overview of the contribution process

image

Picking Your Project

  • Each project has its own purpose
  • Each project has its own culture
  • Does your company want you to work on something specific?

Getting to Know Your Project

  • Clone and be familiar with the code
$ git clone git://git.openstack.org/openstack/<your_project>
  • Example:
$ git clone git://git.openstack.org/openstack/training-guides

Interacting with the Project

  • Talking in the IRC channel
  • Following and participating in project related mail threads in the mailing list
  • Attending regular meetings
  • Filing, fixing, and triaging bugs
  • Filing a blueprint/spec
  • Implementing a blueprint/spec

General Contribution Workflow

  • Pick a task (bug, trivial fix, documentation, implementation)
  • Make a new branch in your local repository
$ git checkout -b name_whatever_you_want
  • Make code changes
  • Update and add tests (unit, functional, etc.)
  • Run tests (unit, functional, etc.)

General Contribution Workflow

  • Create your commit
    • Add files to your commit
    • Commit added files and explain changes in the commit message
  • Push upstream for review

Your Patch Upstream

  • Jenkins and vendor CIs will review your patch
  • Community members will review your patch
  • Reply to comments
  • Make changes and push new patchsets
  • Resolve merge conflicts

Speeding the Acceptance

  • Be on top of people's comments
    • Be patient
    • Be communicative
    • Be collaborative

REMEMBER: This is open source. Things happen on the community's schedule, not yours.

Building Karma

  • Review other's code
  • Fix the documentation
  • Answer questions
  • Attend the meetings

Build Your Network

  • Personal message or talk in the channel to people
  • Ask people you know about the project
  • Ask people about their contributions
  • Ask people about their contribution experience
  • Pay attention to who is an expert in what area
View Git Blame Copy Permalink