Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework contribution section #350

Merged
merged 28 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
b238962
MY Acknowledgements
Aug 9, 2024
ea2045f
typos
Aug 9, 2024
3c72484
Update competencies.md
CaptainSifff Aug 9, 2024
23d41f1
Apply suggestions from code review
CaptainSifff Aug 9, 2024
7e0a2ba
first round of feedback
Aug 9, 2024
265b245
Merge branch 'main' into 333-iterate-the-credit-section
Aug 9, 2024
92c4fdf
Merge branch 'main' into 333-iterate-the-credit-section
Aug 9, 2024
a577c3f
Apply suggestions from code review
CaptainSifff Aug 10, 2024
4f85863
Merge branch 'main' into 333-iterate-the-credit-section
Aug 10, 2024
2195922
feedback by philipp and some bits
Aug 10, 2024
8d4deb8
Apply suggestions from code review
CaptainSifff Aug 10, 2024
45b6929
CrediT citation
Aug 10, 2024
d5f1394
Update competencies.md
CaptainSifff Aug 11, 2024
8e0e9c3
Update competencies.md
CaptainSifff Aug 11, 2024
00d0aa0
combine sentenses
knarrff Aug 12, 2024
1e6dce7
combine sentenses
knarrff Aug 12, 2024
d5ea50d
combine sentenses
knarrff Aug 12, 2024
b633b14
Apply suggestions from code review
CaptainSifff Aug 12, 2024
0ed63fb
remove years
Aug 12, 2024
a332efe
move stuff out into separate acknowledgements file
Aug 12, 2024
5b66ac2
Update competencies.md
CaptainSifff Aug 12, 2024
df15952
Apply suggestions from code review
CaptainSifff Aug 12, 2024
872b75c
improve contributions
Aug 12, 2024
2d59c46
Update competencies.md
CaptainSifff Aug 12, 2024
58ea633
typos
Aug 12, 2024
6ddfe85
typos
Aug 12, 2024
80da8f6
Merge branch 'main' into 333-iterate-the-credit-section
Aug 12, 2024
d2c8aa0
Acknowledgements and bibliography
jngrad Aug 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/spellignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ artifacts
aspirational
backend
Badging
Bernhard
BibTeX
BioExcel
BIOEXCEL-FRAMEWORK
bioinformatician
Expand All @@ -27,6 +29,7 @@ CodeMeta
CodeRefinery
comp-lvls-techn
Coursera
CRediT
CRSP
CSE
curation
Expand Down Expand Up @@ -89,6 +92,7 @@ GPL
habilitation
HAI
Hannay
Hasselbring
HIDA
HIFIS
HMC
Expand Down Expand Up @@ -155,6 +159,7 @@ RSE
RSE's
rse-specialisations
RTPs
Rumpe
scalable
scipy
SeniorCC
Expand Down
2 changes: 1 addition & 1 deletion bibliography
Submodule bibliography updated 1 files
+28 −0 bibliography.bib
49 changes: 42 additions & 7 deletions competencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@ keywords:
- competencies
- curriculum design
- teaching
acknowledgements-before: ""
acknowledgements-after: "
We appreciate the comments and suggestions from Yves Vincent Grossmann,
Wilhelm Hasselbring, and Bernhard Rumpe.
"
abstract: "
The term Research Software Engineer, or RSE,
emerged a little over 10 years ago as a way to represent
Expand Down Expand Up @@ -1500,20 +1505,50 @@ How we update existing institutions and set up new ones
that provide this education will be the topic of a follow-up paper.

# Contribution details {-}
Heidi Seibold came up with the original idea for the deRSE23 workshop.

Heidi Seibold came up with the original idea for the deRSE23 workshop in Paderborn.
Heidi Seibold, Jeremy Cohen, Florian Goth, Renato Alves, Jan Philipp Thiele, and Samantha Wittke organised the deRSE23 workshop.
We thank all the participants of this community workshop!
Heidi Seibold, Jeremy Cohen, Florian Goth, Renato Alves, Jan Philipp Thiele,
and Samantha Wittke organised the deRSE23 workshop.
Toby Hodges conceptualised and organised the un-deRSE23 workshop.
Toby Hodges conceptualised and organised the un-deRSE23 workshop together with Jan Philipp Thiele and Florian Goth.
We also thank all the participants of this follow-up community workshop!

Jeremy Cohen, Gerasimos Chourdakis, Magnus Hagdorn, Jean-Noël Grad, Jan Philipp Thiele, and Matthias Braun organised the deRSE24 workshop in Würzburg.
We are also grateful to the participants of this third community workshop!
Heidi Seibold, Jeremy Cohen, Florian Goth, Renato Alves, Jan Philipp Thiele,
Jan Linxweiler, Jean-Noël Grad, and Samantha Wittke contributed the initial draft.
Florian Goth supervised the project and did the project administration.
Jean-Noël Grad designed and implemented the software tooling.
Michele Martone wrote the first draft of the environmental sustainability section.
Jean-Noël Grad designed and implemented the software tooling for the collaborative writing of this manuscript on GitHub.
Everybody contributed to the final review and editing.


The CRediT system [@Brand2015] is far too generic to adequately describe the contributions of everybody in various workshops, spread over a two year period.
While everybody contributed to the discussion formulating and refining the ideas, and to collaboratively writing and/or reviewing and editing the entirety the script, some parts merit special mention.
Renato Alves quickly jumped in to host the first deRSE23 workshop to take over from a sick organiser.
Matthias Braun contributed early versions of the specialisations and also contributed to the survey.
Leyla Jael Castro contributed to the initial draft of the example career path, and provided helpful insights in discussions on metadata.
Gerasimos Chourdakis' contributions to the paper are numerous (extensively editing large parts of the initial draft), but he especially wrote first drafts for clarifying
the relationship of the RSE competencies to the SE competencies. He also designed the "Learning and teaching RSE" website [@learnandteach].
Simon Christ helped with typesetting and contributed the competencies' symbols and the spell-checker script.
Jeremy Cohen drafted the initial introduction and contributed the tables for RSEs in centralised RSE departments.
Stephan Druskat contributed parts on proper software citation and publication and sharpened various RSE specialisations.
Fredo Erxleben contributed to early discussions of the paper and added the contributions by the Helmholtz Association.
Jean-Noël Grad contributed initial drafts for the ELIXIR framework and the section on the work of the HPC certification forum
as well as numerous other contributions to the BibTeX infrastructure and the GitHub actions.
Magnus Hagdorn drafted and supervised the ethics and values section for an RSE and made sure that these values are reflected in the competencies of RSEs.
Toby Hodges contributed parts on the Carpentries, and helped steer the curriculum discussion.
Guido Juckeland contributed experiences from his first RSE course for students.
Dominic Kempf drafted the first version of the example curriculum.
Anna-Lena Lamprecht helped with proper wording, especially with awareness about established SE terminology, that was misused earlier.
Jan Linxweiler drafted various RSE specialisations and made sure that clean coding techniques got their due recognition.
Frank Löffler rewrote numerous parts to be actually legible, and helped with preparation for the final steps of a de-RSE position paper.
Michele Martone wrote the first draft of the environmental sustainability section.
Moritz Schwarzmeier drafted the categorisation of the specialisations.
Heidi Seibold contributed the idea and started everything.
Jan Philipp Thiele drafted initial parts of the technical pillar of the RSE competencies, and represented the project on numerous discussions.
Harald von Waldow contributed to initial drafts of the Masters program and contributed his knowledge to the explainability of computer simulations.
Samantha Wittke contributed the parts on CodeRefinery and how to reach out to new RSEs.
Florian Goth has the pleasure of being grateful to all collaborators in this project for contributing their time and knowledge into this project!


\appendix


Expand Down
2 changes: 1 addition & 1 deletion contributors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ authors:
orcid: 0000-0003-3239-8554
email: [email protected]
acknowledgements: |
MM acknowledges funding from the SiVeGCS Project
MM acknowledges funding from the SiVeGCS Project.

# please use the following author template (all fields are optional):

Expand Down
6 changes: 6 additions & 0 deletions filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ def process_markdown(metadata, body, contributors):
acknowledgements = ["# Acknowledgements {- #sec:acknowledgements}"]
bookkeeping_initials = {}
author_thanks = get_author_thanks(metadata)
if "acknowledgements-before" in metadata:
acknowledgements.append(metadata["acknowledgements-before"])
del metadata["acknowledgements-before"]
# parse metadata
for fullname, annotations in author_thanks.items():
author_metadata = contributors[fullname]
Expand All @@ -75,6 +78,9 @@ def process_markdown(metadata, body, contributors):
assert initials in message, f"'{initials}' doesn't appear in the acknowledgements of '{fullname}'"
acknowledgements.append(message)
affiliations_tex = [f"\\affil[{key}]{{{affil}}}" for affil, key in affiliations.items()]
if "acknowledgements-after" in metadata:
acknowledgements.append(metadata["acknowledgements-after"])
del metadata["acknowledgements-after"]
# update Markdown metadata
del metadata["author"]
metadata["authorxmp"] = authors_xmp
Expand Down
Loading