Skip to content
Merged
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
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
Comment on lines +1 to +3

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.
Expand Down
3 changes: 3 additions & 0 deletions docs/maintainer/14-ci-preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -172,6 +174,7 @@ Add these workflows incrementally as the codebase matures:
### Documentation Build

```yaml

- name: Build MkDocs
run: |
pip install mkdocs-material
Expand Down
1 change: 1 addition & 0 deletions docs/student/08-branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ git branch
Output:

```

* feature/my-task
main
```
Expand Down
1 change: 1 addition & 0 deletions docs/student/18-exercises.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down