| | 1 | === GOAL: === |
| | 2 | familiarize people with all aspects of contributing and developing to !SasView |
| | 3 | * Lower the “fear of the unknown” barrier to getting started (by knowing rather than guessing at what is involved) |
| | 4 | * A basic understanding of “what/how I might be able to contribute” |
| | 5 | * Where to go to get started. Where to find information, who to talk to etc. |
| | 6 | |
| | 7 | === OUTLINE === |
| | 8 | 2h 17 min (leaves 45 min for questions and discussion and tangents) |
| | 9 | |
| | 10 | * 2 min - Welcome and intro = All the areas are important (hard core coding, documentation, checking math, testing that we get the right answers, testing usability and against crashes, responding to help requests)... |
| | 11 | * Show Roadmap here? Or later? |
| | 12 | * 3 min - goals and outline |
| | 13 | * 20 min - Demo of existing functionality - going through all the menu items and buttons |
| | 14 | * 10 min - Getting Help and Bug reporting -- tickets (user list, help@) - Needs: reporting bugs and responders to queries (from “how do i” to “why does my model not fit my data”) |
| | 15 | * 10 min - How to write and distribute a model and the model marketplace. Needs: contributing models |
| | 16 | * 35 min - Code structure (where bits live) - Needs: contributing non model code and testing and validation |
| | 17 | * 5 min - !SasView, sasmodels, bumps |
| | 18 | * 20 min !SasView |
| | 19 | * 10 min - sasGUI |
| | 20 | * 10 min - sasCalc |
| | 21 | * 10 min - sasmodels |
| | 22 | * 20 min - Documentation - Needs: contributing documentation |
| | 23 | * 5 min - Overview |
| | 24 | * Use Sphinx to build both dev and user |
| | 25 | * Uses RST and Latex - currently builds html but plan for a pdf also |
| | 26 | * 4 min - Dev - Needs: lots of doc strings still missing |
| | 27 | * 4 min - docstrings at the start of “each” class and method |
| | 28 | * 10 min - User - Needs: never finished |
| | 29 | * 5 min - each section has an RST file (and images as appropriate) |
| | 30 | * 5 min - Models = the first doc string in the file is scraped to go into model documentation |
| | 31 | * 1 min - Tutorial …. Need a new one - Needs: help developing tutorial materials |
| | 32 | * 37 min - “Dev ops” |
| | 33 | * 2 min - Basic concepts in version control - EVERYTHING is under version control!! |
| | 34 | * 10 min Git code hosting |
| | 35 | * 7 min - Concepts in version control (repos, cloning, branching (vs. forking - baaaad), committing (with comments),pull requests, code review |
| | 36 | *3 min - Setting notifications etc |
| | 37 | * 25 min - “show me the code”- Needs: developers of all stripes = architecture, GPU, math whiz, sysadmins, ... |
| | 38 | * 5 min - Git code repos (all of them), branches, stats… and CODE |
| | 39 | * 5 min - Compiling/run.py and local environment |
| | 40 | * 5 min - Py2exe and Ino -> installer |
| | 41 | * 5 min - CI - eventually NOT local environment - real test is final build |
| | 42 | * Travis |
| | 43 | * Jenkins |
| | 44 | * 5 min - progress -->trac → ticket -> work |
| | 45 | * Trac wiki |
| | 46 | * Trac tickets, milestones, workpackages, roadmap (trac version) |
| | 47 | * Concluding remarks?? |
