Hadar repository is split in many parts.
hadar/ source code
hadar/
tests/ unit and integration tests perform by unittest
tests/
examples/ set of notebooks used like End to End test when executed during CI or like tutorials when exported to html.
examples/
docs/ sphinx documentation hosted by readthedocs at https://docs.hadar-simulator.org . Main website is hosted by Github Pages and source code can be find in this repository
docs/
.github/ github configuration to use Github Action for CI.
.github/
We use all github features to organize development. We implement a Agile methodology and try to recreate Jira behavior in github. Therefore we swap Jira features to Github such as :
Jira
github swap
User Story / Bug
Issue
Version = Sprint
Project
task
check list in issue
Epic
Milestone
We respect git flow pattern. Main developments are on develop branch. We accept feature/** branch but is not mandatory.
develop
feature/**
CI pipelines are backed on git flow, actions are sum up in table below :
action
release/**
master
TU + IT
3.6, 3.7, 3.8 / linux, mac, win
linux-3.7
E2E
from source code
from test.pypip.org
Sonar
yes
package
to test.pypip.org
to pypip.org