CCSCNE 2014 MouseTrap Hackfest Agenda
(Difference between revisions)
Heidi.ellis (Talk | contribs) (Created page with "<h1>CCSCNE 2014 MouseTrap Hackfest Agenda</h1> This page describes the pieces that you need to know to participate in the hackfest. If you are just joining, feel free to start...") |
Heidi.ellis (Talk | contribs) |
||
| Line 1: | Line 1: | ||
<h1>CCSCNE 2014 MouseTrap Hackfest Agenda</h1> | <h1>CCSCNE 2014 MouseTrap Hackfest Agenda</h1> | ||
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. | 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. | ||
| − | <h2>Set-Up</h2> | + | <h2>Step 1 - Set-Up</h2> |
# [http://foss2serve.org/index.php/MouseTrap_Dev_Help#Complete_Git_and_Mousetrap_Install| Download and install MouseTrap] | # [http://foss2serve.org/index.php/MouseTrap_Dev_Help#Complete_Git_and_Mousetrap_Install| Download and install MouseTrap] | ||
| − | <h2>Orientation</h2> | + | <h2>Step 2 - Orientation</h2> |
# Join the IRC channel: | # Join the IRC channel: | ||
## Install an IRC client if you do not already have one. [https://addons.mozilla.org/en-US/firefox/addon/chatzilla/| Chatzilla] installs quickly and easily in Firefox. | ## Install an IRC client if you do not already have one. [https://addons.mozilla.org/en-US/firefox/addon/chatzilla/| Chatzilla] installs quickly and easily in Firefox. | ||
| Line 14: | Line 14: | ||
# Go to the [https://git.gnome.org/browse/mousetrap/ MouseTrap git repo] and look for recent commits. Note that we are working on the <b>gnome3-wip</b> branch. | # Go to the [https://git.gnome.org/browse/mousetrap/ MouseTrap git repo] and look for recent commits. Note that we are working on the <b>gnome3-wip</b> branch. | ||
# To to the [https://bugzilla.gnome.org/buglist.cgi?quicksearch=mousetrap| MouseTrap Bugzilla] site. Review current bugs. What has yet to be done? | # To to the [https://bugzilla.gnome.org/buglist.cgi?quicksearch=mousetrap| MouseTrap Bugzilla] site. Review current bugs. What has yet to be done? | ||
| − | * | + | # 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: |
| − | * | + | #* <tt>git status</tt> Identifies any files that have been changed but not committed or any new #files added that have not been committed. |
| + | #* <tt>git log</tt> Show you the log of any commits that you have made. | ||
| + | #* <tt>git add <filename></tt> Adds the <filename> to your local git repo. | ||
| + | #* <tt>git commit</tt> Commits your changes to your local git repo. | ||
| + | |||
* Patches | * Patches | ||
* GNOME Love | * GNOME Love | ||
| − | <h2>Workflow</h2> | + | <h2>Step 3 - Workflow</h2> |
| − | <h2>Apply Patch</h2> | + | Like most FOSS projects, the workflow for MouseTrap involves the following steps (assuming that you have MouseTrap downloaded and installed: |
| − | <h2>Reviewing Bugs</h2> | + | # Identify a bug to be fixed or enhancement to be made in Bugzilla. |
| − | <h2>Hacking!</h2> | + | # Write the code to fix the bug or implement the enhancement. |
| + | # Test your code thoroughly. If necessary, include test results. Some FOSS projects will not accept a patch without successful test cases. | ||
| + | # Create a patch. A detailed explanation may be found [http://ariejan.net/2009/10/26/how-to-create-and-apply-a-patch-with-git/| here]. | ||
| + | # Upload the patch to the appropriate bug in Bugzilla. | ||
| + | ## Bugzilla will automatically generate an email notifying the maintainers that a patch has been submitted. | ||
| + | ## The maintainer(s) will then download and test the patch. | ||
| + | ### If the patch has issues, the maintainer(s) will comment on the patch and kick it back to you for modification. | ||
| + | ### If the patch is wonderful, the maintainer(s) will commit the patch to the appropriate branch. | ||
| + | |||
| + | <h2>Step 4 - Apply Patch</h2> | ||
| + | <h2>Step 5 - Reviewing Bugs</h2> | ||
| + | <h2>Step 6 - Hacking!</h2> | ||
Revision as of 13:22, 14 April 2014
Contents |
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
Step 2 - Orientation
- Join the IRC channel:
- Install an IRC client if you do not already have one. Chatzilla installs quickly and easily in Firefox.
- Attach to the GNOME server: /attach irc.gnome.org
- Join the MouseTrap channel: /join #mousetrap
- Give yourself a nick: /nick <yourname>
- Join the conversation!
- Go to the wiki and read what MouseTrap is all about.
- Go to the MouseTrap git repo and look for recent commits. Note that we are working on the gnome3-wip branch.
- To to the MouseTrap Bugzilla site. Review current bugs. What has yet to be done?
- 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:
- Identify a bug to be fixed or enhancement to be made in Bugzilla.
- Write the code to fix the bug or implement the enhancement.
- Test your code thoroughly. If necessary, include test results. Some FOSS projects will not accept a patch without successful test cases.
- Create a patch. A detailed explanation may be found here.
- Upload the patch to the appropriate bug in Bugzilla.
- Bugzilla will automatically generate an email notifying the maintainers that a patch has been submitted.
- The maintainer(s) will then download and test the patch.
- If the patch has issues, the maintainer(s) will comment on the patch and kick it back to you for modification.
- If the patch is wonderful, the maintainer(s) will commit the patch to the appropriate branch.
