open source contribution

7/31/2019 Open Source Contribution

1/16

Open SourceContributionHOWTOs

Madan U S


2/16


3/16

TopicsTopics

User's Life CycleGeneral Open Source GuidelinesWhy should you contribute?

Which ProjectThe SystemThe CommunityThe License

The OrganizationGuidelinesIndian ContextProductivity Tips and Guidelines


4/16

User's Life cycleUser's Life cycle

Hey thats cool!I want to know moreDownloadUntar

Read the Install.txtInstall


5/16

General GuidelinesGeneral Guidelines

RTFMSearch Archives and ask your friend (Search Engines)

IRCs

Email- Read the Email guidelines- Watch where you mail- Make it easy to read

- Be Nice- Be quiet

Be Smarthttp://www.catb.org/~esr/faqs/smart-questions.html


6/16

Why should I contribute?Why should I contribute?


7/16

Which Project?Which Project?


8/16

How can *I* Contribute?How can *I* Contribute?Help Others Learn- Participate In the Mailing Lists- Promote the tool- Link to the project site

Maintainance activities- Maintain the website- Monitor the IRC channels and mailing lists

Release and Quality- Write unit tests- File Bug reports

- Triage and Reproduction- Adding to the build/test farm- Release management- Provide Packages for download

Documentation

- Wiki and Manuals- Translations


9/16

How can *I* Contribute?How can *I* Contribute?

Last but not the leastCode- Provide patches- Committer Activities


10/16

The SystemThe SystemPlatform- Website- Docs- Mailing Lists

* user* dev* release* announce* archive

- IRC Channels* user* dev

- Repository with Access Control- Issue Tracker


11/16

The CommunityThe Community

Committers and the Laymanhttp://www.webkit.org/coding/commit-review-policy.htmlTeams and Leads

Patience
http://www.webkit.org/coding/commit-review-policy.htmlhttp://www.webkit.org/coding/commit-review-policy.html


12/16

The LicenseThe License

Copyright and CopyleftConservatives and Liberals

http://opensource.org/licenses/category
http://opensource.org/licenses/categoryhttp://opensource.org/licenses/category


13/16

The OrganizationThe Organization

Non-Profit CorporationLoosely built communityIncubated by a For-Profit Corporation

Community Look-Alikes


14/16

GuidelinesGuidelinesFrom http://poi.apache.org/guidelines.html

Read the rest of the website, understand what POI is and what it does, the project vision, etc.Use POI a bit, look for gaps in the documentation and examples.Join the mailing lists and share your knowledge with others.Get Subversion and check out the POI source treeDocumentation is always the best place to start contributing, maybe you found that if the documentation

just told you how to do X then it would make more sense, modify the documentation.

Contribute examples - if there's something people are often asking about on the user list which isn'tcovered in the documentation or current examples, try writing an example of this and uploading it as apatch.

Get used to building POI, you'll be doing it a lot, be one with the build, know its targets, etc.Write Unit Tests. Great way to understand POI. Look for classes that aren't tested, or aren't tested on a

public/protected method level, start there.Download the file format documentation from Microsoft - OLE2 Binary File Formats or OOXML XML File

Formats

Submit patches (see below) of your contributions, modifications.Check the bug database for simple problem reports, and write a patch to fix the problemReview existing patches in the bug database, and report if they still apply, if they need unit tests atc.Take a look at all the unresolved issues in the bug database, and see if you can help with testing or

patches for themAdd in new features, see Bug database for suggestions.

http://www.apache.org/dev/contributors.htmlhttp://wiki.apache.org/nutch/Becoming_A_Nutch_Developerhttp://www.webkit.org/coding/contributing.html
http://poi.apache.org/guidelines.htmlhttp://www.apache.org/dev/contributors.htmlhttp://wiki.apache.org/nutch/Becoming_A_Nutch_Developerhttp://www.webkit.org/coding/contributing.htmlhttp://www.webkit.org/coding/contributing.htmlhttp://wiki.apache.org/nutch/Becoming_A_Nutch_Developerhttp://www.apache.org/dev/contributors.htmlhttp://poi.apache.org/guidelines.html


15/16

Indian ContextIndian Context

@ Are you using open source?@ How much do you care?@ Are you *using* open source?@ Are you using your company's resources?

@ Have you given a link to your patches in your resume?

@ Have you given preferential treatment to employers who are open toOpen Source contributions@ Have you spoken to your management about giving back to thecommunity of the tools that you use in the organization?


16/16

Productivity TipsProductivity Tips

Watch and Learn Request to shadow your hero

ChatKeep your Open Source Desktop always On (Use Virtual Machines)Take the time to learn the tools that help you get your work done fasterUse the On and Off Switch

open source contribution

Documents