Revision as of 16:49, 23 April 2014

CCSCNE 2014 MouseTrap Hackfest Agenda

This page describes the pieces that you need to know to participate in the hackfest. If you are just joining, feel free to start with "Set-Up" and work your way towards "Hacking". Feel free to grab a mentor or anyone in the room and ask for help.

Step 1 - Set-Up

1. Download and install MouseTrap
2. Read the README.md file and follow instructions for running mousetrap.

Step 2 - Orientation

1. Join the IRC channel:
   1. Install an IRC client if you do not already have one. Chatzilla installs quickly and easily in Firefox.
   2. Attach to the GNOME server: /attach irc.gnome.org
   3. Join the MouseTrap channel: /join #mousetrap
   4. Give yourself a nick: /nick <yourname>
   5. Join the conversation!
2. Go to the wiki and read what MouseTrap is all about.
3. Go to the MouseTrap git repo and look for recent commits. Note that we are working on the gnome3-wip branch.
4. To to the MouseTrap Bugzilla site. Review current bugs. What has yet to be done?
5. Code - Note that any changes in your code will not be automatically stored in your local copy of your repo. You will need to tell git to add any new files and to commit the changes. Some helpful commands:
   • git status Identifies any files that have been changed but not committed or any new #files added that have not been committed.
   • git log Show you the log of any commits that you have made.
   • git add <filename> Adds the <filename> to your local git repo.
   • git commit Commits your changes to your local git repo.

• Patches
• GNOME Love

Step 3 - Workflow

Like most FOSS projects, the workflow for MouseTrap involves the following steps (assuming that you have MouseTrap downloaded and installed:

1. Identify a bug to be fixed or enhancement to be made in Bugzilla.
2. Write the code to fix the bug or implement the enhancement.
3. Test your code thoroughly. If necessary, include test results. Some FOSS projects will not accept a patch without successful test cases.
4. Create a patch. A detailed explanation may be found here.
5. Upload the patch to the appropriate bug in Bugzilla.
   1. Bugzilla will automatically generate an email notifying the maintainers that a patch has been submitted.
   2. The maintainer(s) will then download and test the patch.
      1. If the patch has issues, the maintainer(s) will comment on the patch and kick it back to you for modification.
      2. If the patch is wonderful, the maintainer(s) will commit the patch to the appropriate branch.

Step 4 - Apply Patch

1. Look at bug report for the PEP8 bug
   1. Has the bug been confirmed?
   2. Is the bug report complete? Are there details missing?
   3. Is there a patch?
   4. Review the patch. Test it.
      1. Look at the diffs
      2. Make sure that the code does everything it is supposed to and not anything else.
      3. Make sure that the code complies with all standards.
2. Try it! https://bugzilla.gnome.org/show_bug.cgi?id=728182

Step 6 - Hacking!

Create a bug report. If you find a bug, report it! Create a new bug report and provide complete information on what you found.