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

[DRAFT] Start of process for "Foundational competencies and responsibilities of an RSE" as an official position of de-RSE e.V. #15

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
161 changes: 161 additions & 0 deletions .github/spellignore.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
ADDME
AllDigital
anonymise
APIs
artifacts
aspirational
backend
Badging
BioExcel
BIOEXCEL-FRAMEWORK
bioinformatician
bioinformatics
Bioschemas
Braunschweig
BSSW
CASTIEL
Carpentries
CarpentriesData
CarpentriesLibrary
CarpentriesSoftware
Center
CHAOSS
codebase
CodeRefinery
comp-lvls-se
Coursera
CRSP
CSE
cybersecurity
DALIA
DaLiJe
de
DFG
DigComp
DigCompEdu
DigCompOrg
DigiFlex
digitalisation
DigitalSkillsGap
distributable
DMP
DOCBB
DOMREP
EBI
ECTS
EduTrain
edX
EMBL
EMBL-EBI
eng
ENCCS
EOR
Erlangen-Nürnberg
ERuDIte
EuroCC
EuroHPC
examplemaster
exascale
ExCALIBUR
EXCELERATE
executables
FAIRness
FAU
findability
findable
FIXME
Forschung
Friedrich
Fortran
franca
funders
FutureUniversity
genomic
GitHub
GitLab
GDPR
GPL
habilitation
HAI
Hannay
HIDA
HIFIS
HMC
HPC
HPC-Akademie
HPC-CF
HPC-oriented
HTC
IDEs
Ing
ISCB
Jena
JOSS
JU
Kanban
KDL-CAREERS
KSA
KSAs
LIBS
lingua
LLM
LLMs
LRZIntroCpp
LRZModernCpp
matplotlib
MATSE
MOOCs
MPI
multicore
multithreading
NFDI
NFDI4Ing
numpy
OECD
OER
OpenScience
Orithena
OSI-approved
Paderborn
pdf
PerMedCoE
PhDs
PRACE
pre-recorded
pre-requisite
proto
PRs
RDM
RDM-RSE
repos
reproducibility
ReproHack
researchology
researchonomy
reusability
RSE
RSE's
rse-specialisations
RTPs
scipy
SeniorCC
SRU
SSI
sth
SureSoft
SusTrainable
SWLC
swrepo
swrepos
SWREPOS
SysOps
tbl
TeSS
teams-se
TrainingMaterial
UofO
un-deRSE
US-RSE
WIP
Wissenschaft
Zenodo
48 changes: 48 additions & 0 deletions .github/workflows/compile.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: compilepaper
on: [push]
jobs:
paper:
runs-on: ubuntu-latest
env:
DIR: .
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install pandoc
run: |
sudo apt-get update && sudo apt-get install -y --no-install-recommends \
texlive texlive-latex-extra pandoc latexmk \
texlive-bibtex-extra biber \
texlive-fonts-recommended texlive-fonts-extra lmodern fonts-linuxlibertine \
python3 python3-yaml \
xz-utils make gpg-agent
python3 -m pip install -r ${{ env.DIR }}/002/requirements.txt
- name: pandoc compile
working-directory: ${{ env.DIR }}/002/
run: make all
- name: move
run: mkdir -p github_artifacts && mv ${{ env.DIR }}/002/*.pdf ./github_artifacts/
- name: Upload pdf as artifact
uses: actions/upload-artifact@v3
with:
name: PDF files
path: ./github_artifacts
deploy:
needs: [paper]
runs-on: ubuntu-latest
if: ${{ github.repository == 'CaptainSifff/paper_teaching-learning-RSE' && github.ref == 'refs/heads/main' }}
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: actions/download-artifact@v3
with:
path: github_artifacts
- name: move
run: mkdir -p github_deploy && mv github_artifacts/*/* github_deploy
- name: deploy on orphan branch
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./github_deploy
publish_branch: build
force_orphan: true
42 changes: 42 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: 'spellcheck'
on:
workflow_dispatch:
pull_request:
push:
branches:
- main

jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: "populate spellignore"
run: |
for file in "*.md"
do
# strip citations and references
sed -ri 's/\[@[A-Za-z0-9_ ;@-]+\]//g' $file
sed -ri 's/[^#\[][@#][A-Za-z0-9_ ;@-]+:[A-Za-z0-9_ ;@-]+}*//g' $file
sed -ri 's/@[A-Za-z0-9_]+//g' $file
# strip words that escape the spellchecker allowlist
sed -i 's/Dr.-Ing.//g; s/Ph.D.//g; s/M.Sc.//g; s/B.Sc.//g; s/Fortran//g;' $file
# latex commands
grep -P -oh -e "(?<=[\\\\\{])[A-Za-z]+" $file | sort | uniq >> .github/spellignore.txt
# RSE compositions
grep -P -oh -e "[\w-]*RSE[\w-]*" $file | sort | uniq >> .github/spellignore.txt
# remove header
sed -i '1,/---/{/^---$/,/^---$/d}' $file
done
- name: "populate spellignore with author names"
uses: mikefarah/yq@master
with:
cmd: |
yq '.authors[] | .lastName' contributors.yml | sed 's/ /\n/g; /null/d' >> .github/spellignore.txt
yq '.authors[] | .firstName' contributors.yml | sed 's/ /\n/g; /null/d' >> .github/spellignore.txt
yq '.authors[] | .suffixName' contributors.yml | sed 's/ /\n/g; /null/d' >> .github/spellignore.txt
- uses: eschercloudai/[email protected]
with:
files-to-check: "competencies.md|call_to_action.md|survey.md|institutionalised_education.md|intro.md"
files-to-exclude: "CONTRIBUTING.md\nREADME.md"
words-to-ignore-file: .github/spellignore.txt
6 changes: 6 additions & 0 deletions 002/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
call_to_action.pdf
competencies.pdf
institutionalised_education.pdf
intro.pdf
survey.pdf
build/
128 changes: 128 additions & 0 deletions 002/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
Florian Goth <[email protected]>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
Loading