pyiron / pyiron/pyiron_module_template
New module template available
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
@pyiron/pyiron
I just wanted to ping you all that this new repository is now here to allow for an easy start of a new pyiron module. If you encounter any bug/ anything missing/ anything that needs to be updated please open an issue/PR to fix this.
Another point: In the last pyiron meeting we discussed to use this template repo also to synchronize our CI. I tested to use a template like a fork and this does not work as intended. I.e. an update of the template is not reported and can not be pulled into the created repository which is based on the template. Other ideas welcome!
We could:
- Update all shared files of all repositories to one version and use the patches within this repo to update all the others (maybe this is automatable?)
- Use another repository like
ci_supportand make it a submodule to all repos (e.g. using a.static_ci_supportdirectory to hold most of the shared files - this excludes all workflows from being synchronized) - Make a different
ci_supportrepository mirroring our usual structure similar to this template and include only files identical in all repos and- iterate over all
pyiron_-repositories for every change in these files and update those - automate this using a workflow of the
ci_supportrepo
- iterate over all
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No specific files, tests, or entry points are named. Start by reviewing the template repository's shared files and workflows, then compare the proposed patch, submodule, and ci_support approaches. Done requires choosing and implementing a synchronization strategy across the pyiron repositories.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- build-system, ci-cd, devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100