Skip to content

Commit 369d6d7

Browse files
committed
update(README & CHANGELOG): add some updates and modify some details
1 parent c462044 commit 369d6d7

2 files changed

Lines changed: 26 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,34 @@ All notable changes to this project will be documented in this file.
55
The project uses lightweight semantic versioning (pre-1.0): `vMAJOR.MINOR.PATCH`.
66

77
## [Unreleased]
8-
- Planned: evaluation write-up, report figures, and reproducibility polish.
8+
### Planned
9+
- Evaluation write-up (usability + correctness narrative) and evidence curation for the final report.
10+
- Reproducibility polish: curated figures in `report/figures/` and consistent evidence bundles (JSON + trace + PNG).
11+
- Issue tracking cleanup (labels, milestones) and documentation consolidation.
912

10-
## [0.3.1] - YYYY-MM-DD
13+
## [0.3.2] - 2025-12-20
14+
### Fixed
15+
- CI smoke-tests workflow: updated to run from the repository root after promoting the tool to the top-level directory (resolves CI failure due to missing `ds-mutex/` working directory).
16+
17+
### Changed
18+
- Repository hygiene / presentation: updated GitHub repository metadata (About description, topics, Pages link) to reflect the Distributed Mutual Exclusion artefact.
19+
20+
### Notes
21+
- This release is intended as a **freeze baseline** tag for reproducible evidence collection (report figures, traces, and exported state).
22+
23+
## [0.3.1] - 2025-12-18
1124
### Added
12-
- RA message fault controls: drop next in-flight message; arm/drop-next-send (drops next outgoing message).
13-
- Evidence exports: state JSON + trace TXT + preview PNG (timestamped).
25+
- Ricart–Agrawala (prototype) fault controls:
26+
- Drop next in-flight message (drops queue head).
27+
- Arm/disarm drop-next-send (drops the next outgoing message).
28+
- Evidence exports:
29+
- State JSON
30+
- Trace TXT
31+
- Preview PNG
32+
- Timestamped export naming to support reproducible reporting.
1433

1534
### Improved
16-
- Trace clarity for stalled states (e.g., waiting for missing REPLY after a drop).
35+
- Trace clarity for stalled states, including explicit explanation when progress halts due to missing REPLY(s) after message drops (safety preserved; liveness may fail under message loss). Example traces show “no messages in flight” after a dropped REQUEST to a target process.
1736

1837
### Notes
19-
- Ricart–Agrawala module is a teaching-oriented prototype. Safety is prioritised; liveness may be violated under message loss, which is intentionally demonstrated.
38+
- Ricart–Agrawala module is a teaching-oriented prototype. Safety (mutual exclusion) is prioritised; liveness may be violated under message loss, which is intentionally demonstrated via faults and trace output.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,4 +129,4 @@ npm test
129129

130130
## Licence
131131

132-
Add a licence if required by your course / publication method (e.g., MIT). If not, state “All rights reserved” by default.
132+
All rights reserved.

0 commit comments

Comments
 (0)