DiamondLightSource / DiamondLightSource/python-copier-template

Consider merging with scientific-python template

Open
#150 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jinja
Stars
25
Forks
10
Avg merge
4h 4m
Merged PRs (30d)
6

Description

In May ~2024~ 2023, NSLS-II and scikit-hep merged their templates and associated development guides into one [template](https://github.com/scientific-python/cookie) and [guide](https://learn.scientific-python.org/development/), under the `scientific-python` org. We have seen advantages in maintenance: with shared effort, the shared template is staying better up to date. Our opinions and use cases are not _perfectly_ aligned, but we have been able to find rough consensus on technology choices, and so far we find the benefits of sharing to be higher than the costs.

Let's explore whether it would make sense to merge the DLS/Bluesky copier template into this. Initial questions:

- What technology/layout choices differ between them?
- What would it take to provide facility-specific defaults during set up, so that a new user can mostly just press `` and get the appropriate license file and other facility-local settings? Even if this required an enhancement to copier itself, that could be doable.

Contributor guide

Open the contributing guide

Research direction

Compare the DLS/Bluesky copier template with the linked scientific-python template and development guide, focusing on technology and layout differences. Then investigate how facility-specific defaults, license files, and other local settings could be supplied during setup, including whether copier needs an enhancement. Done means producing a consensus-backed merger plan or documenting why the templates should remain separate.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.