Skip to content

Commit 595dcaf

Browse files
refactor: migrate Markdown to AsciiDoc (#54)
Automated migration of .md to .adoc per global rules, preserving wikis and critical exceptions.
1 parent d5e3187 commit 595dcaf

22 files changed

Lines changed: 433 additions & 399 deletions

ARCHITECTURE.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
== Architecture
2+
3+
=== Overview
4+
5+
This repository follows a modular, maintainable architecture designed
6+
for clarity, scalability, and long-term sustainability.
7+
8+
=== Directory Structure
9+
10+
....
11+
.
12+
├── src/ # Source code
13+
├── tests/ # Test suites
14+
├── docs/ # Documentation
15+
├── scripts/ # Utility scripts
16+
├── config/ # Configuration files
17+
├── LICENSE # License file
18+
├── LICENSES/ # Full license texts
19+
└── README.adoc # Project documentation
20+
....
21+
22+
=== Design Principles
23+
24+
* *Separation of Concerns*: Each module has a single responsibility
25+
* *Testability*: Code is written to be easily testable
26+
* *Documentation*: All public APIs are documented
27+
* *Configuration*: Environment-specific settings are externalized
28+
29+
=== Dependencies
30+
31+
* External dependencies are minimized and clearly declared
32+
* Version pinning is used for reproducibility
33+
34+
=== Security Considerations
35+
36+
* Sensitive data is never committed to the repository
37+
* Secrets are managed through environment variables or secure vaults
38+
* Regular dependency audits are performed
39+
40+
=== Maintainability
41+
42+
* Code follows consistent style guidelines
43+
* Pull requests require review and CI checks
44+
* Issues and discussions are tracked transparently
45+
46+
'''''
47+
48+
_Last updated: 2026-07-18_

ARCHITECTURE.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

CHANGELOG.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
== Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on https://keepachangelog.com/en/1.1.0/[Keep a
6+
Changelog], and this project adheres to
7+
https://semver.org/spec/v2.0.0.html[Semantic Versioning].
8+
9+
=== [Unreleased]

CHANGELOG.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

CODE_OF_CONDUCT.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
== Contributor Covenant Code of Conduct
2+
3+
=== Our Pledge
4+
5+
We pledge to make participation a harassment-free experience for
6+
everyone.
7+
8+
=== Our Standards
9+
10+
*Positive behavior:* * Using welcoming language * Being respectful of
11+
differing viewpoints * Accepting constructive criticism * Focusing on
12+
what is best for the community
13+
14+
*Unacceptable behavior:* * Harassment, trolling, or personal attacks *
15+
Publishing private information without permission
16+
17+
=== Enforcement
18+
19+
Report issues to the maintainers. All complaints will be reviewed.
20+
21+
=== Attribution
22+
23+
Adapted from https://www.contributor-covenant.org/[Contributor Covenant]
24+
v2.1.

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

CONTRIBUTING.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
== Contributing
2+
3+
[arabic]
4+
. Fork the repository
5+
. Create a feature branch
6+
. Ensure SPDX headers on all files
7+
. Submit a pull request
8+
9+
*Author:* Jonathan D.A. Jewell j.d.a.jewell@open.ac.uk

CONTRIBUTING.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

GOVERNANCE.adoc

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
== Governance
2+
3+
=== Overview
4+
5+
This project is governed by the following principles and structures to
6+
ensure transparent, inclusive, and effective decision-making.
7+
8+
=== Roles and Responsibilities
9+
10+
==== Maintainers
11+
12+
Maintainers are responsible for: - Reviewing and merging pull requests -
13+
Managing releases and versioning - Ensuring code quality and standards -
14+
Triaging issues and bug reports - Community engagement and support
15+
16+
==== Contributors
17+
18+
Contributors are expected to: - Follow the code of conduct - Submit
19+
well-documented pull requests - Write tests for new functionality -
20+
Maintain existing tests - Update documentation as needed
21+
22+
=== Decision Making
23+
24+
==== Minor Changes
25+
26+
* Can be made by any maintainer
27+
* Include bug fixes, documentation updates, dependency updates
28+
29+
==== Major Changes
30+
31+
* Require discussion in issues or pull requests
32+
* Include new features, architectural changes, API changes
33+
* Need approval from at least 2 maintainers
34+
35+
==== Breaking Changes
36+
37+
* Require RFC (Request for Comments) process
38+
* Need approval from majority of maintainers
39+
* Must include migration guide
40+
41+
=== Code of Conduct
42+
43+
All participants are expected to follow our Code of Conduct. Violations
44+
can be reported to the maintainers.
45+
46+
=== Communication
47+
48+
* *Issues*: For bug reports and feature requests
49+
* *Discussions*: For questions and general discussion
50+
* *Pull Requests*: For code contributions
51+
52+
=== Licensing
53+
54+
All contributions are made under the terms of the repository’s LICENSE
55+
file. By submitting a pull request, you agree to license your
56+
contributions accordingly.
57+
58+
'''''
59+
60+
_Last updated: 2026-07-18_

GOVERNANCE.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

0 commit comments

Comments
 (0)