Prerequisites
Assumes basic inductions completed:
Assumes guidelines:
Infrastructure
Mentor to add the new hire to the appropriate online resources:
Calendars
- Edge Team: for holidays, meaningful events
- Edge Sprint Demo: add invitee
- IG Sprint: add invitee
- IG Standup: add invitee
- Grenoble:
- Grenoble holidays: if you're in Grenoble, record your vacations here
- Bristol: ?
Slack
IG
- #ig
- #ig-dev
- #ig-backend
- #ig-engineering
- #ig-vcs
- ...
Edge
- #fr-edge-team: private for team members (management)
- #edge-engineering
Set-up
Laptop setup
Development environment setup:
- java
- maven
- git/ stash
- Bitbucket
- IntelliJ (Community-only)
Git issues on Mac:
- Download git - if not installed:
- There is an issue where your git installation may be overridden by the MacOS (Xcode) veneer. To overcome this:
- Don't bother trying to mv /usr/bin/git /usr/bin/git/system - as the Mac security does not permit this (even as root)
- Just confirm your git installation is working and alias it:
See below:
- There is an issue where your git installation may be overridden by the MacOS (Xcode) veneer. To overcome this:
Codebase setup
IG git repos:
For each desired repo, fork then clone...
- Instructions:
- Create your own ssh key (ssh-keygen)
From the master repo, fork it:
Forking it allows you to have your own copy of the repo.
Clone your forked repo on your laptop - with command line or with SourceTree:
e.g. git clone ssh URL of your new forked repo
Pyforge setup
Pyforge is a python-based functional testing framework used by IG QA. It is also very useful in quickly configuring an environment representing a particular use-case.
It may not be immediately useful to you. To install and configure see Pyforge Installation Guide.
IG Resources
- IG Home:
- General IG artifacts: some design docs, how-to, etc
- IG Planning Home
- IG Sprint Overview
- Sprint themes and goals
- Sprint reports and demos (recordings)
- IG Open Issues (bugster)
- IG docs:
- IG docs on Backstage
- IG docs on early access
Conventions
Git commit
The team follows this convention: https://chris.beams.io/posts/git-commit/
With the addition of the JIRA issue number as a commit message prefix: OPENIG-666 Add support for CORS
Training
- Getting Started Guide (6.5)
- Let's get IG up and running...
- Gateway Guide (6.5)
- a deeper understanding
- Installation and configuration: sections 1 and 2
- Tutorials - start with: 5, 6, 9, 10
- How to file a bug
If necessary:
1 Comment
Laurent Vaills
For Git, Java, Maven I highly encourage to use homebrew : https://brew.sh/
Also use jenv if you need to switch between java versions.
For Python it seems the best way to handle it is to install pyenv from brew then the desired version of Python with pyenv.