Contributor's Guide

Overview

We would like more people to use, contribute to, and maintain Gobblin. These three aims align with the 3 main roles of members within our community : users, contributors, and committers/maintainers. We would like to instill a sense of ownership and pride among the members of our community by encouraging:

• people to use Gobblin
• users to contribute to Gobblin
• contributors to become committers

You can contribute to Gobblin in many ways such as:

• reporting bugs
  • Use https://issues.apache.org/jira/browse/GOBBLIN
• suggesting features and Road Map items
  • Email the Dev list
• submitting pull-requests for both bug fixes and new features
  • Use https://issues.apache.org/jira/browse/GOBBLIN and point it to an Open Github Pull Request
• attending Gobblin meet-ups
  • Eg. check Apache Gobblin Meetup
• helping in answering questions on the dev email list, PRs, and JIRAs
  
  

Best Ways to Engage the Community!

There are many ways today for members of the community to connect with others in the community. These include :

• Sending an email to dev@gobblin.incubator.apache.org (after registering, c.f. Contributor's Guide)
  • Best way to initiate a long tail discussion
• Asking a question on Slack 
  • Community members including contributors / committers hang out on Slack and should be able to answer your questions
  • Best way to get a quick response
• Open a JIRA when a bug is found & propose a PR with a Fix
  • Only way to get PRs approved or to report bugs

Does Your Company Use Gobblin?

Details on Contributing

Getting Started

In order to contribute to Gobblin, please be sure to:

• Have some questions?
  • Send emails to the dev list listed below
  • Ask question from the community on user list 
• Register on the following Apache mailing lists
  • dev@gobblin.incubator.apache.org
    
    • Start by sending an email to dev-subscribe@gobblin.incubator.apache.org - this will initiate an automated subscription process
    • The dev lists is where we, as a community, share information, pose and answer questions, and vote on policy changes
  • commits@gobblin.incubator.apache.org
    
    • Start by sending an email to commits-subscribe@gobblin.incubator.apache.org - this will initiate an automated subscription process
    • The commits list is updated by comments on Jiras and PRs and is the way you can keep abreast of discussions around Jiras.
• Sign up for both https://issues.apache.org/jira/browse/GOBBLIN and https://cwiki.apache.org/confluence/display/GOBBLIN accounts
• Visit and read docs on https://github.com/apache/incubator-gobblin & Gobblin Home

Submitting PRs

• When filing PRs, remember to 
  • Rebase your fork (http://stackoverflow.com/a/7244456/1110993)
  • Squash your commits
  • Create a JIRA for your bug fix/feature enhancement - point the JIRA "External Issue URL" to your PR URL
  • Preface your commit's subject & PR's title with [GOBBLIN-XXX], where XXX is the JIRA number, and add a JIRA link in the PR description
    • Some folks only preface the PR title with [GOBBLIN-XXX], but we also need the commit message subject to contain the JIRA id. This is because we use the subject line in the commit messages when creating the release notes. 
  • Add an Apache License header to all new files
  • & follow the 7 rules of good Git commits