27
Your First Patch to OpenStack By Akanksha Agrawal and Sana Khan

Your first patch to OpenStack

Embed Size (px)

Citation preview

Your First Patch to OpenStackBy Akanksha Agrawal and Sana Khan

About Us

● Outreachy (https://outreachy.gnome.org) interns @OpenStack

● https://akankshaha.wordpress.com

● https://sanakhan2011.wordpress.com

Agenda

● Why contribute to OpenStack?

● Ways in which you can contribute

● Steps to contribute

● Questions?

Why should You contribute to Openstack?

● Beginner friendly and active contributor community

● Work on the project being used by millions

● Get to learn from experienced developers around the world

● Rich set of guidelines and documentation

● Huge bunch of interesting things to learn

Who can contribute to OpenStack?

● Anyone

Ways in which you can contribute?

You can work on a wide range of things:

● Documentation

● A New Feature

● Help Fix Bugs

● Report Bugs

● Bug Triaging

● Translation

https://wiki.openstack.org/wiki/How_To_Contribute

Steps to follow

Step 1: Get Your Accounts Created

1. Register your Launchpad account at https://login.launchpad.net

2. Sign Up for Foundation Membership at the OpenStack Foundation

● Complete The Individual Member Application

● Read and Sign the terms of becoming an OpenStack Foundation Individual Member.

https://www.openstack.org/join

3. Gerrit Review System

● Log into with your Launchpad account.

● Use the same username for Gerrit as the Launchpad username.

● Sign the appropriate Individual Contributor License Agreement

● Upload your Public SSH Key to review.openstack.org

Step 2: Setting up DevStack1. Install Virtual Machine

2. Clone devstack repository

a. $ git clone https://git.openstack.org/openstack-dev/devstack.git

3. Go to the devstack directory

a. $ cd devstack

4. Copy local configuration file from devstack/samples to devstack

a. cp samples/local.conf local.conf

5. Run the stack.sh script

a. $ ./stack.sh

Step 3: Selecting a bug to work upon

Selecting your Project

Go the Bugs Page

Advanced Search Options

Customise Visible Bug Information

Sort by Age, Last Updated Date, Assignee

Selecting a low-hanging fruit

Assigning the Bug to Yourself

Step 4: Fixing the bug

● Try to reproduce the bug using Devstack.

● In case of doubts, add a comment to the bug report.

● If you need more assistance, you can seek help on IRC or Mailing List

● IRC Channel List : https://wiki.openstack.org/wiki/IRC

● Mailing Lists : https://wiki.openstack.org/wiki/Mailing_Lists

Step 4.1: Fixing the bug - Workflow

1. Configure git and git-reviewa. $ git config --global user.name "Firstname Lastname"

b. $ git config --global user.email "[email protected]"

c. $ git config --global gitreview.username yourgerritusername

d. $ git review -s

2. Clone the projecta. $ git clone https://git.openstack.org/openstack/<projectname>.git

3. Make sure you have the latest upstream changesa. $ git remote update

b. $ git checkout master

c. $ git pull --ff-only origin master

Step 4.1: Fixing the bug - Workflow

4. Create a topic brancha. $ git checkout -b TOPIC-BRANCH

b. Name the branch as : bug/BUG-NUMBER

5. Make code/doc changes

6. Test your changes

Step 5: Committing the Change

1. $ git commit -a

Step 6: Sending the patch upstream for review

1. $ git reviewYou will get the link where your patch is uploaded for review on review.openstack.org

2. Address the review comments and resend the patch if required.

Thank You!Find us @:

● Akanksha Agrawal○ IRC Handle: Akanksha08@freenode○ Twitter Handle: @AkankshaHA○ https://www.linkedin.com/in/Akanksha08

● Sana Khan○ IRC Handle: buttercup@freenode○ Twitter Handle: @sanakhan_libre