Skip to content

Commit 276fa6d

Browse files
Update/licensing to pmpl ccby (#135)
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk> --> ## Summary <!-- What does this PR do, and why? --> Closes # ## Type of change - [ ] 🐛 Bug fix (non-breaking change that fixes an issue) - [ ] ✨ New feature (non-breaking change that adds functionality) - [ ] 💥 Breaking change (would change existing behaviour) - [ ] 🕳️ Soundness fix (fixes a checker/proof false-negative) - [ ] 📖 Documentation - [ ] 🧹 Refactor / tech debt (behaviour-preserving) - [ ] ⚡ Performance - [ ] 🔧 Build / CI / tooling ## How has this been verified? <!-- Establish ground truth: which tool did you RUN, and what did it report? Don't cite a status doc — cite the command and its output. --> ## Checklist - [ ] My commits are **signed** (`git commit -S`). - [ ] I ran the project's own checks/tests locally and they pass. - [ ] New files carry the correct `SPDX-License-Identifier` (code/config `MPL-2.0`, prose `CC-BY-SA-4.0`); I did not relicense existing files. - [ ] Docs are updated, and no public claim now overstates what the code does. - [ ] I have not introduced a soundness hole (or I have flagged where I might have). ## Notes for reviewers <!-- Anything that needs special attention, follow-up, or context. --> --------- Co-authored-by: Mistral Vibe <vibe@mistral.ai>
1 parent e895aa4 commit 276fa6d

17 files changed

Lines changed: 1852 additions & 113 deletions

File tree

.github/FUNDING.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
github: [hyperpolymath]
1+
# SPDX-License-Identifier: MPL-2.0
2+
github: hyperpolymath
23

.github/funding.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Funding Configuration
2+
# See: https://docs.github.com/en/repositories/managing-your-repositorys-custom-fields/displaying-a-sponsor-button-in-your-repository
3+
4+
github: metadatastician

.github/workflows/codeql.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,6 @@ jobs:
5353
uses: github/codeql-action/analyze@e0647621c2984b5ed2f768cb892365bf2a616ad1 # v3
5454
with:
5555
category: "/language:${{ matrix.language }}"
56+
57+
- name: SonarCloud Scan
58+
uses: SonarSource/sonarqube-scan-action@master

ARCHITECTURE.md

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

GOVERNANCE.md

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

0 commit comments

Comments
 (0)