diff --git a/docs/index.md b/docs/index.md index f84d23d..c48c614 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ -# NNU-PP Research Software Handbook +# Meridex Research Software Handbook -Welcome to the official software engineering handbook for the NNU-PP research group. +Welcome to the official software engineering handbook for the Meridex research group. This handbook defines **how research software is developed, reviewed, and maintained in the group**. It covers the complete workflow from first setup to long-term repository maintenance. diff --git a/docs/maintainer/14-ci-preparation.md b/docs/maintainer/14-ci-preparation.md index f9ab097..dcca0b3 100644 --- a/docs/maintainer/14-ci-preparation.md +++ b/docs/maintainer/14-ci-preparation.md @@ -154,6 +154,7 @@ Add these workflows incrementally as the codebase matures: ### Code Style (flake8 / ruff) ```yaml + - name: Lint with ruff run: | pip install ruff @@ -163,6 +164,7 @@ Add these workflows incrementally as the codebase matures: ### Type Checking (mypy) ```yaml + - name: Type check with mypy run: | pip install mypy @@ -172,6 +174,7 @@ Add these workflows incrementally as the codebase matures: ### Documentation Build ```yaml + - name: Build MkDocs run: | pip install mkdocs-material diff --git a/docs/student/08-branches.md b/docs/student/08-branches.md index 654108e..4aaca64 100644 --- a/docs/student/08-branches.md +++ b/docs/student/08-branches.md @@ -99,6 +99,7 @@ git branch Output: ``` + * feature/my-task main ``` diff --git a/docs/student/18-exercises.md b/docs/student/18-exercises.md index 3a3cf70..2195a06 100644 --- a/docs/student/18-exercises.md +++ b/docs/student/18-exercises.md @@ -84,6 +84,7 @@ git checkout -b docs/add-your-name Edit `CONTRIBUTORS.md` and add one line: ``` + - Your Name (Year) — Brief description of your research area ```