Merge pull request #20 from gi-ev/markdown_review_guidelines

Review Markdown of guidelines and link to issues to create subsequent version

Author: SNielebock

.github/workflows/deploy_pages.yml

@@ -30,4 +30,4 @@ jobs:
         if: github.event_name == 'push' && github.ref == 'refs/heads/main'
         uses: oprypin/push-to-gh-pages@v3
         with:
-          publish_dir: site
+          publish_dir: site

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: end-of-file-fixer      # Ensure existence of newline characters at file ends
+  - id: check-yaml      # Make sure that contained YAML files are well-formed
+  - id: trailing-whitespace      # Trim trailing whitespace of all sorts
+  - id: check-added-large-files      # Apply a file size limit of 500kB
+  - id: requirements-txt-fixer      # Sort lines in requirements files
+  - id: mixed-line-ending      # Ensure consistent line endings
+
+- repo: https://github.com/rhysd/actionlint
+  rev: v1.7.8
+  hooks:
+  - id: actionlint      # GitHub Actions Workflow linter

README.md

@@ -8,6 +8,15 @@ This results in consequences both for the leadership to provide organizational s
 
 The authors propose these guidelines as a template to aid universities, colleges, and research institutions in the adaptation of fundamental policies and recommendations for research projects involving research software.
 
+[View Guidelines](https://doi.org/10.18420/2025-gi_de-rse) (DOI: 10.18420/2025-gi_de-rse)
+
+### Current Versions of the Guideline
+
+- [German Version v1.0](RSE_Leitlinien_Softwareentwicklung.md)
+- [English Version v1.0](RSE_Leitlinien_Softwareentwicklung-en-US.md)
+
+- [Known Issues and Features to be added in the subsequent version 1.1](https://github.com/gi-ev/RSE-software-entwicklungs-leitlinien/issues?q=is%3Aissue%20state%3Aopen%20label%3Av1.1)
+
 # Purpose
 
 This guidelines template proposes the establishment of specific guidelines within universities, colleges, and research institutions. It aims to provide concrete assistance for defining their own guidelines while allowing for flexibility to accommodate the different cultures in various disciplines and research institutions through explicit variability for refinement.
@@ -23,7 +32,7 @@ We would also appreciate feedback on which university, college, or research cent
 
 # RSE-Website template
 
-needs to be set up - as GitHub pages? Or complete WS? If the latter, who will host it?
+A template for an institute's RSE website can be found [here](website_template/).
 
 # Glossar (currently only in German)