1 / 14

Contributing to ODTBX: A Guide for MacOS

Contributing to ODTBX: A Guide for MacOS. Ravi Mathur Updated December 5, 2012. Introduction – Git Clients. ODTBX uses Git (see the ODTBX Git Tutorial ) SourceForge account needed (free). Recommended Git Clients

graiden-poole
Download Presentation

Contributing to ODTBX: A Guide for MacOS

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Contributing to ODTBX:A Guide for MacOS Ravi Mathur Updated December 5, 2012

  2. Introduction – Git Clients • ODTBX uses Git (see the ODTBX Git Tutorial) • SourceForge account needed (free). • Recommended Git Clients • Command Line: Built-in git client. Get it by installing XCode (available from App Store), then going to XCode Preferences  Downloads  Command Line Tools. Use the command-line version of this tutorial. • SourceTree is a free full-featured GUI client for Mac. This guide assumes SourceTree is being used, but other GUI clients will have similar functionality.

  3. Get the ODTBX Repository • SourceTree Clone Repository: File  New • ODTBX URL: • ssh://username@git.code.sf.net/p/odtbx/git 1: Your SourceForge username (enter password later) 2: Desired repo location 3: Desired SourceTree name 4: Clone it! (~400MB download, may take time) Read do’s and don’ts while waiting…

  4. Contributing – Do’s • Make sure your name & email are set in Git • You should get credit for your work! • SourceTree: Preferences…  General • Submit code for one feature at a time. • Repeat this process for each feature to submit. • Comment and organize your code • Make it easy for ODTBX developers to understand and incorporate your code into ODTBX. • Test your code before submitting • Needs no explanation…

  5. Contributing – Don’ts • Don’t use the repo to “dump” documents • EVERYONE will download EVERYTHING you submit! • We don’t want to bloat the main ODTBX repo. • Use the ODTBX webpage for this (ask Admin). • Don’t commit audio/video/multimedia files. • Exception: files that are necessary for code to work (e.g. graphics needed by a custom GUI). • Exception: articles/papers directly explaining algorithms used in your code. • Don’t commit ITAR/sensitive code • The SourceForge repo is VERY public!!

  6. ODTBX Developer Setup • ONLY DO THIS STEP IF: • You need to test your code with ODTBX. • Otherwise, skip this entire slide (e.g. if you are just submitting codefor review). • On the ODTBX Developer Wiki • Follow the “Tools & Environment Setup” page. • Make sure you set up your startup.m file. • Test by running estbat_test in Matlab. • It should return 0 (zero) if successful. • Don’t worry about warnings from the test.

  7. Branches in Git • If you know Subversion, FORGET SUBVERSION. • Git branches are VERY light, VERY easy to use. Currently Checked-out Branch (in bold) Double-click to checkout “develop” branch ALWAYS start from the “develop” branch!!

  8. Step 1: Create a Branch • Start by checking out the “develop” branch. • SourceTree: Repository  Branch… • Verify that your branch is checked out! MUST branch from “develop”!! Short descriptive branch name

  9. Step 2: Organize Your Files • Create new folder at root of your ODTBX repo • All your files (source, documents, etc…) go in here. • Use the same name as your branch. • Only add files to odtbx/ or vendor/folders if you were approved to do so. Your folder: Organize your submission files in here

  10. Step 3: Add Your Files to Repo 1: Make sure your branch is checked out 2: Select “Working Copy” 3: Select your code folder 4: “Add” folder to the repo

  11. Step 4: Commit Your Files 1: “Commit” work to your repo 2: Add commit message - Check Author Name & Email

  12. Step 5: Submit Your Branch • Get permission from ODTBX admin first! • Request access to ODTBX “contributor” group • SourceTree: Repository  Push… ✔ 1: Select your branch to push it to SourceForge - Unselect “develop” 2: Push it! Everything committed to your branch will be added to SourceForge.

  13. Wrap-Up Submission • Inform ODTBX Admin(s) of contribution • Include your branch name • Your files will be evaluated…patience! • Code evaluation will be done by ODTBX developers … you may be asked for clarification. • Code incorporation can be tracked by doing a Git “Pull” while your branch is checked out. • SourceTree: Repository  Pull… • You will have to do “Developer Setup” to test your files within ODTBX.

  14. Conclusions / Notes • Thank you for your submission! • ODTBX Admins listed on SourceForge • http://sourceforge.net/projects/odtbx/

More Related