-
Notifications
You must be signed in to change notification settings - Fork 81
3rd September 2020
agrimwood edited this page Sep 3, 2020
·
1 revision
Presentation: N/A
Chair: NMB
Minutes: AG
Yunguan Fu YF
Ester Bonmati EB
Adria Casamitjana AC
Zac Baum ZB
Shaheer Saeed SS
Yipeng Hu YH
Qianye Yang QY
Alex Grimwood AG
Zhe Min ZM
Nina Montana Brown NMB
Remi Delaunay RD
Matt Clarkson MC
Dean Barratt DB
Who | Discussion Points | Next |
---|---|---|
Zac Baum | Automated builds; when to trigger? On push to main? On tags? We then need to only push to main sparingly (maybe <1x per week - and sig. changes) Use GH Actions and have it done automatically, not relying on commits/tags happening? | |
Ester Bonmati | ||
Adria Casamitjana | Improve demo performance | |
Matt Clarkson | ||
Remi Delaunay | ||
Yunguan Fu | main/dev branches Remove output tests Post r1 plan? Fix issues Add methods Improve contributing guidelines Auto CI release Commit message | Demo tests Version format Main/dev (explanation if merge to main) Integration test for main only |
Alex Grimwood | ||
Yipeng Hu | Promotion Core dev team going forward | |
Nina Montana Brown | Review with team “new” (cropped) JOSS paper: got flagged due to length so some hefty content modifications that need to be checked | |
Saeed Shaheer | ||
Qianye Yang | ||
Zhe Min |
Proof reading paper
Branch merging guidelines
Post r1 contribution guidelines
Versioning/release guidelines (auto-gen release notes)
NB:
- Paper was submitted - congratulations!
- Editors state it is too long and needs reducing
- YH & YF have started to reduce - all urged to check repo and offer feedback
- YH to open an issue on repo
- Master branch has been split to main branch and dev branch
YH:
-
Thanks extended to everyone
-
Promote the repo, suggestions include:
- Citations (all)
- Twitter (all)
- Formal UCL/institutional activities (YH)
- LinkedIn post via UCL/personal accounts (ZB)
- CMIC Seminar (YH)
- TF spotlight competitions (NB)
- Core dev team and other credits have changed. If you accept a task/ticket, you will remain/become a core dev team member
- In future, credits could be updated
- Encourage members of the public to contribute - they can be credited
YF:
-
Post r1 plan
-
All docs now on readthedocs (must be adapted and added manually)
-
New issue submission template
- All issues should be branched from dev
- PRs should be raised for merge into dev
- Dev branch will collect changes and periodic changes released by merging onto Main branch
- only hotfixes/breaking bug-fixes can be merged directly to Main
- YH - what criteria for directly merging to main?
- Agreed number of approvers needs to be increased
- NB - please formalise guidance for this!
- EB will testing criteria be updated to reflect new version controls?
- ZB suggests explicitly identifying merge target (main/dev) in pull request form with accompanying reasons etc.
- YH to raise issue
- Output testing - CI takes too long due to output tests
- No longer useful or practical
- Unit tests cover majority of functionality
- ZB - agrees removing output test for dev branch, but retaining for main branch (more info: Conditional Builds, Stages and Jobs)
-
Post r1 issues are almost all issue fixes
-
enhancements and extensions:
- YH remember contrib folder (e.g. QY’s work)
- Threshold for contrib is up for discussion - prelim: citation & integration testing
- Issue raised regarding commit message style to enable automated generation of release notes
- ZB - suggested example https://github.com/github-tools/github-release-notes, ensure issue name and all other descriptors are helpful/directly relevant
ZB:
- What goes into main, when, how often?
- Should releases be semi-automatic, or does it need manual mediation?
- Entirely depends on frequency of updates, so tag/action codes are appealing
- YF - other packages/readthedocs: tags define the stable releases. Package releases should only be tagged version updates, ideally every few months
- EB - tag management/versioning: what strategy to use/is being used?
- YF - release versioning criteria: xxx.xxx.xxx = maj.minor.patch (https://semver.org/)
tables: for google docs --> markdown, use tablesgenerator.org
formatting: for google docs --> markdown, use stackedit