No edit summary
|Line 36:||Line 36:|
** Why it matters: The OpenHatch project's documentation is out of date, which means that newcomers will be misled!
** Skills you will learn and/or apply: Editing Python documentation using Sphinx & rST, which are common on the open source Python world.
* Add a navigation link within a part of the site, so users don't get lost: https://github.com/openhatch/oh-mainline/issues/1385
** Why it matters: This part of the web app is easy for people to get lost in.
** Skills you will learn and/or apply: Django templates, general understanding of how web apps work.
** Other links: https://hashman.ca/gsoc/ is the blog posts by the author of this part of the site, which is the best documentation available for it.
Revision as of 08:00, 15 November 2014
This page exists to provide you with good, small tasks as you get started contributing to open source projects.
Every project on this page has:
- Clear instructions for how to contribute to their project, including setting up a development environment, contributing changes, and how to contact them.
- At least one hand-picked task that (hopefully!) can be completed within an hour or two.
- At least one maintainer/contributor who's really excited about welcoming you to their project.
If you don't find any tasks you'd like here, try these additional sources:
- This page has curated tasks from previous events, but there are no maintainers for these projects at the event. That said, other mentors will probably be able to help you.
- Search 700+ open source projects at once
- Find a project that fits your interests using this guide.
You can see past first tasks, which have been successfully resolved, here.
This page was last curated 5/10/2014. Tasks on this page may have been resolved since then, so check their status in their respective issue trackers.
- Project Overview
- Setting up the development environment
- Contributing changes
- Contact info: paulproteus (aka, Asheesh) on #openhatch ; also, see community page in the documentation
- Code: https://github.com/openhatch/oh-mainline
Each of these is a bug that you should fix on your computer, and when you are satisfied with the fix, create a pull request for. These are supposed to be sorted from easiest to hardest, though your mileage may vary.
- Update some documentation to indicate that it has broken links <https://github.com/openhatch/oh-mainline/issues/1427>
- Why it matters: The OpenHatch project's documentation is out of date, which means that newcomers will be misled!
- Skills you will learn and/or apply: Editing Python documentation using Sphinx & rST, which are common on the open source Python world.
- Add a navigation link within a part of the site, so users don't get lost: https://github.com/openhatch/oh-mainline/issues/1385
- Why it matters: This part of the web app is easy for people to get lost in.
- Skills you will learn and/or apply: Django templates, general understanding of how web apps work.
- Other links: https://hashman.ca/gsoc/ is the blog posts by the author of this part of the site, which is the best documentation available for it.
- Footer doesn't always stick to the bottom of the page <https://github.com/openhatch/oh-mainline/issues/1437>
- Skills you will learn and/or apply: HTML, CSS
- https://openhatch.org/bugs/issue898 -- Sign up for an account on AppVeyor and configure their site to automatically periodically test if oh-mainline runs properly on Windows.
- Skills you will learn and/or apply: Automation (like scripting), using Windows.
- http://openhatch.org/bugs/issue71 -- add support to the site for Gravatars. Very open ended at the moment. I would prefer to leave the task of actually downloading the Gravatar to be done in the user's web browser, but that might seem kind of like an odd implementation strategy.
- Skills you will learn and/or apply: Reading documentation for third-party services; general understanding of HTML; editing Django templates.
- https://github.com/openhatch/oh-mainline/issues/1367 -- Right now, when you interact with some parts of the OpenHatch site, it incorrectly triggers a notification on the front of the site.
- Why it matters: The site mistakenly tells people some content is newer than it is.
- Skills you will learn and/or apply: Django and Python, aka "backend web programming".
Open Source Comes to Campus website
Shauna added (integrated these when the above are checked):
- Go through the laptop setup pages and add screenshots where you think they would be helpful. The issues say to add images to the issue, but you can upload them directly to the wiki if you like (though you may have to get permissions).
- Reproduce documentation issue A student reported an issue with the documentation for XChat. We've now switched to HexChat. Does the documentation still need to be fixed?
Mozilla, the non-profit makers of Firefox, creates products designed to help people take control and explore the full potential of their lives online.
Good first tasks:
- Triage bugs in Firefox for Android: Improve the quality of bugs reported for Firefox on Android
- Why this matters: Bugzilla is Mozilla's bug tracking system. This is where bugs are reported and where every change for a bug is stored and tracked. Bugs can stay unnoticed in Bugzilla for a long period of time. They are either not moved to the right component or are missing vital information to get them in developers’ hands. Help us reduce the number of UNCOnfirmed bugs in the Bugzilla database, and to improve the quality of the bugs reported.
- Test the new Flash player for Firefox, called Shumway, by watching Flash videos and looking for differences.
Description: WelcomeBot is an IRC bot designed to welcome people into the #openhatch IRC channel (although it can be easily adapted for use in other channels). It is written in python, and features the socket module.
- Overview and installation/contributing guides: can be found in the repository's readme.
- Main contact: Shauna (shauna on Freenode; shaunagm at gmail dot com)
- Updates/problems/ideas: Please use the issue tracker! (As well as asking shauna about them on IRC.)
- Add rules to catch unidentified nicks - When users who have registered their nicknames join IRC without identifying, different IRC clients will change their nickname in different ways. The bot currently only accounts for one of those ways, which means people are greeted unnecessarily.
- Bot does not recognize fast name change - When users join the channel and change their name, the bot uses their original name to greet them. A fix for this would likely involve:
Harder tasks that may still be fun:
- Bot goes offline silently - Every couple of weeks, the bot experiences a bug and turns off silently. Investigate tools like cronjob, monit, nagios, etc so that we can get a notification if it goes offline.
- Make test suite - If you like testing, this is the task for you! A good first step would be to read through the script and identify what needs to be tested. Alternatively, if you could read through some of the resources listed in the issue and report back what you've learned about doing tests in python, that would be super helpful too. This project's maintainer has never developed tests before from scratch, so we are all in it together. :)
- bug causing bot to go offline - This may be a tricky bug to fix, since it's not clear what input is causing the crash and it may be difficult to reproduce (the bot currently crashes on this bug approximately every two weeks). But you may be able to figure out what's going on from the information given!
- Overview: OpenStreetMap website - explore the map! Here's a summary of the project, and here's the Wikipedia article.
- Development information: The "Develop" page explains the main components of OpenStreetMap and how they fit together, linking to the code and issue trackers for those individual components. There are also lots of smaller OSM-related open source tools that aren't listed on that page, like the OSM Tasking Manager and MapRoulette projects mentioned below.
- Contact info: The #osm-dev IRC channel (on the OFTC network) includes many contributors. Here's their page about IRC, including a webchat link you can use to connect to #osm-dev. The "Develop" page also links to a mailing list for developers.
- Testing documentation: OSM wants people to be able to easily use its freely-licensed data instead of using Google Maps data, so it has a website teaching people how to do this: Switch2OSM. The author of the "Loading OSM data" article (pnorman on IRC) would like feedback on this article! This article expects having access to an Ubuntu instance, and it is designed to be usable for anyone with basic Linux and PostGreSQL knowledge. You can write down comments about the article (and any difficulty you ran into while following it), such as in an Etherpad, and then send the link to pnorman in the #osm-dev IRC channel. If you don't already have convenient access to a computer or server running Ubuntu, you can try setting up a free Amazon Web Services EC2 "microinstance" to play with.
- Fixing frontend code: MapRoulette is a fun tool that recommends map edits for you to make. The code is on GitHub here, with issues listed here. This issue looks like a good one to get started with fixing: "because we use element fadeouts quite a bit, we should probably disable buttons visually right when the user clicks them - right now there is no visual feedback when clicking a button, other than the dialog fading".
- Verifying a reported frontend bug: The OSM Tasking Manager also helps map editors find editing tasks to work on. The code is on GitHub here, with issues listed here. You could help the project by seeing if you can reproduce this reported bug: "Seems when scrolling up or down with the mouse wheel within the embed map, it moves both the map scale and the webpage scrollbar" - and then add more details to that bug in a comment.
- Changing frontend code: The OpenHatch at UC Davis page uses a Google Map - how about switching that to an OpenStreetMap instead? Here's some documentation for how to do this: "Embeddable HTML with an added Marker". The code is here: oh-davis.github.io.
- Writing user experience feedback: Make an OpenStreetMap account and try making some map edits (such as correcting any incorrect streets or street names in your neighborhood), and write down notes on your thought process and any problems you encounter, especially parts of the interface you find confusing or frustrating. The default map editing tool is called iD, and you can file bugs here. If you don't know exactly what to report as a bug, you can also write about your experience on the OpenStreetMap website using the built-in "diary entry" feature, and then other OpenStreetMap developers and users can read your feedback to help them figure out how to improve OpenStreetMap.
Description: Please describe your project here. Make sure to mention the overall goal of your project as well as mentioning the main technologies it uses. People using this page may be doing searches for keywords such as topics, types of software, or language names, so make sure they can find your project!
- Project Overview
- Setting up the development environment
- Contributing changes
- Contact info