Skip to content

Amsterdam'14 Hackathon (FINISHED)

dblommesteijn edited this page Nov 21, 2014 · 1 revision

Location & Room

SURFsara
SciencePark 140
1098XG Amsterdam

We've got the Collaboratorium room, visit the link to get an impression.

IMPROVEMENTS based on Invenio:

  • move assets (css/js) to the new (python coded) way, see the invenio doc.
  • add versioning for code ...

Topics:

  • Lars Holm Nielsen, overview of Invenio internals:

    • documents vs records
    • the new json format
    • Overlays: How to separate you code from the main Invenio repository.
    • How to contribute (i.e. coding standards, pull request, milestones, testing).
    • Deposit module/REST APIs
    • Invenio future plans.
  • B2SHARE's future direction?

    • Integrate closer with Invenio? distance from Invenio?
    • ~450KLOC py/js/html in Invenio; B2SHARE part is ~7KLOC
    • a clean B2SHARE, from scratch, could take 40K (user management, deposit upload/view, search, rest api)
    • DECISION: staying with Invenio. Keep for the moment (end of Eudat1) the current depositing module.
  • The new development structure/procedure/workflow:

    • GIT (github)
      • Working with GIT in general
      • The new GIT structure: branches for versions, see Dennis' mail
      • Naming conventions
        • Release branches
        • Released versions/ tags
        • Branch name on pull-request
        • Tagging issue #number in content body
    • Release policy (how often?)
    • Coding standards/ conventions for Python
    • Testing in general; selenium; purpose of testing (TDD, integration, validation, QA)
      • Unit tests (how to)
    • DECISIONS:
      • Pull requests should have a description and a (linked) ticket number for the solved issue
      • Branches for solving issues should be named on the form branch_number#issue_number-description, eg 1.0#415-Firefox-search-bar-width
      • Branches for released versions are named with the version number only (e.g. 1.0); tags has a 'v' in front of the number
      • The sprint cycle is two weeks. First week focus on testing and bug fixing
      • From October milestone on, new code which is not GUI should have tests
      • Long term, we will gradually move to test driven development
  • RESTapi

  • Miscellaneous

    • github labels for issues: copy invenio structure?
      • priority: high, medium, low
      • type: bug, feature
      • difficulty: high, medium, low
      • status: open, in-progress, review, closed
      • site: production, test, trng, dev
      • module: deposit, UI, abuse, ...
    • remove very old branches on github

Agenda

  • 9:00 - 9:30 - Intro, setup, coffee;
  • 9:30 - TBA
  • 12:00 - 13:00 - Lunch break (sandwiches will be provided);
  • 13:00 - TBA
  • 17:00+ - Drinks?

Participants

http://doodle.com/pa8t8fkxnkwy3zqf

  • Carl Johan
  • Sarah
  • Lassi
  • Emanuel
  • Lars (Invenio)
  • Dennis