Today's Question:  What does your personal desk look like?        GIVE A SHOUT

Forgotten TODOs: ideas for contributing to open-source projects

  Ivan Zuzak        2012-03-03 22:30:28       3,180        0    

I often talk to students that want to contribute to open-source projects, but just don't have an idea what to work on. Here's a tip if you're in a similar situation (e.g. you want to apply for GSOC) :

1 git clone repository_url_of_some_open_source_project target_directory
2 grep -RIn TODO target_directory/*

So, find the URL of the repository project you want to contribute to, checkout the repository using git/mercurial/svn and then find all the TODOs in the source code using grep. The -RIn flags will tell grep to do a recursive search (-R), skip binary files (-I) and include line numbers (-n) for results. And that's it! Go through the results and pick whatever you find interesting and within your skill range.

Most open-source projects have issue trackers for organizing bug reports and feature requests that need to be worked on. However, some projects don't use issue trackers, and there's an important difference between issues in these trackers and what you'll find by digging through the source code. Issues are commonly a result of using a system or library, they are created by users, and focus on bugs and features. TODOs on the other hand are a result of system development and are created by developers. Software developers often make notes (TODOs) of things that should be fixed or could be done in a better way, but don't have the time to do it right away.

These notes are focused more on improving the internal operation of the system rather than on externally observable features, and include anything from checking specific algorithm edge-cases to larger refactoring ideas. And as time goes by, these TODOs are often forgotten since they are not systematically tracked and more effort is put into developing new features and fixing bugs. So, if you really want to get your hands dirty, TODOs are a good place to start looking for work. At first, project owners and maintainers will often be cautious about letting you hack into system internals, but will generally be very grateful if you really want to fix those forgotten TODOs.

Here's the number of TODOs for the top 15 watched projects on GitHub:

Project name Number of TODOs
bootstrap 7
nodejs 904 (many of these are v8 TODOs)
rails 77
jquery 7
html5-boilerplate 2
homebrew 22
spoon-knife 0
impress.js 0
backbone 4
diaspora 16
three20 25
devise 2
jquery-mobile 60
three.js 43
express 3

Of course, in some projects you won't find any TODOs, in others you'll find false positives and TODOs from 3rd party libraries, but in general - forgotten TODOs are a cool way of finding ideas for contributing to open-source projects.

Source:http://ivanzuzak.info/2012/03/03/todos-ideas-for-contributing-to-open-source-projects.html

OPEN SOURCE  TODO  CONSTRIBUTION  PARTICIPATION 

Share on Facebook  Share on Twitter  Share on Weibo  Share on Reddit 

  RELATED


  0 COMMENT


No comment for this article.